장고 프로젝트에서 코드의 품질을 유지하고 코드 검사를 자동화하여 실수를 줄 일 수 있는 방법 중 하나인 Pre-commit에 PEP8 스타일 가이드를 검사하는 pre-commit의 설정과 pre-commit의 사용법에 대해서 작성해 보려고 한다. Pre-commit 이란?pre-commit는 Git에서 훅을 관리하고 실행하기 위한 프레임 워크이다. 코드가 커밋되기 전에 자동으로 다양한 검사를 수행하여 코드 품질을 유지하고, 실수를 줄일 수 있도록 도와준다. 예를 들어, 코드 스타일 검사, 정적 분석, 테스트 실행 등을 자동으로 수행할 수 있게 도와준다. 왜 필요할까?프로젝트의 코드 품질을 유지하는 것은 매우 중요하다. 하지만 스타일 가이드만 예로 들어도 적절한 컨벤션과 스타일 가이드를 매번 확인하기..
분류 전체보기
소프트워에 개발 과정에서 예외처리는 필수적인 요소이다. 예외가 발생했을 때 이를 적절히 처리하지 않으면 프로그램이 비정상적으로 종료되거나 예상치 못한 동작들을 할 수 있다. 기본적인 예외처리는 간단한 방식으로 구현되지만, 프로젝트가 복잡해질수록 더 정교하고 유연한 예외처리 전략이 필요하다. 앞서 내가 진행했던 커스텀 예외처리에 관한 글인데, 당시에는 부족한 부분도 많고 재대로 이해하지 못한 부분도 있었고 아래 글 처럼 진행하였더니 여러 불편한 상황들이 많아서 더 안정적이고 유지보수, 가독성이 많이 발전된 코드를 작성하게 되어서 이 글을 작성하게 되었다. [Custom] DRF Custom exception fomat (exception_handler)Response에 이어서 exception_handle..
프로젝트를 하면서 커밋 메시지에 오타가 있거나 내용을 빼먹고 이미 푸시까지 해버렸고 이런 실수는 프로젝트의 문서화와 이력 관리에 혼란을 줄 수 있기 때문에, 정확하게 수정하는 방법을 알고있어야한다. 프로젝트를 진행하면서 나 역시 간단한 오타, 내용의 누락 등 이 있었고 솔직히 이야기하면 굳이 수정해야하나? 라는 생각도 했었다. 하지만 명확하고 정확한 커밋은 팀원들이 변경사항을 이해하고 코드를 추적하는데 큰 도움이 된다. 잘못된 정보가 포함된 커밋 메시지는 혼란을 야기하고, 향후 문제를 진단하거나 해결하는데 어려움을 초래할 수 있다. 라는 이야기가 있어 작은 실수를 확실히 바로잡는게 중요하다고 생각하여 찾아보게 된 내용이다. 커밋 메시지 수정하기우선 바로 직전 메시지를 수정한다고 가정하고 진행해보도록하겠다..
유닛 테스트는 프로젝트에서 중요한 역할을 한다. 각 기능이 올바르게 동작하는지 확인하고, 코드의 변경이 기존 기능에 부정적은 영향을 미치진 않았는지 학인 및 기존 코드의 동작을 보장해 준다. 일반적으로 Django의 유닛 테스트는 별도의 테스트 데이터 베이스를 사용하여 진행되지만 개인적으로 불편하고 데이터 베이스 없이 테스트를 수행하는 것이 더 효율적일 수도 있다는 이야기가 있어서 진행해 보았다. TEST DB를 사용하지 않았을 때의 장점속도 향상 - 데이터베이스 없이 테스트를 실행하면 테스트 속도가 향상된다.환경 구성 단순화 - 별도의 데이터베이스 구성이 필요 없어, 테스트 환경을 쉽게 설정할 수 있다.데이터 베이스의 독립성 - 데이터베이스 의존성 없이 테스트를 구성함으로써 독립적인 단위 효과를 효과..
GitHub는 소프트웨어 개발 프로젝트의 협업 도구로서 중추적인 역할을 한다. 특히, 여러 리포지토리를 관리하는 경우, 일관된 이슈 및 PR 템플릿과 라벨 설정은 프로젝트의 효율성을 크게 향상시킬 수 있다. 본 글에서는 이러한 설정을 손쉽게 복사하고 적용하는 방법과 Organization Repository에 Labels를 적용하는 방법에 대해서 정리해 보려고한다. 기본적으로 진행하기 전 리포지토리 생성을 해줘야한다. 이후, 블로그에서 진행되는 md 파일이나 json 파일은 개인 취향/프로젝트 규칙에 맞게 작성하면 좋을 것 같다. 이슈 템플릿 생성이슈 템플릿은 직업 리포지토리에 파일로 저장해서 진행할 수 있고, github의 도움을 받아서 진행할 수 있다. - 이부분에 관해서는 깃허브 페이지에 자세히..
