장고 프로젝트에서 코드의 품질을 유지하고 코드 검사를 자동화하여 실수를 줄 일 수 있는 방법 중 하나인 Pre-commit에 PEP8 스타일 가이드를 검사하는 pre-commit의 설정과 pre-commit의 사용법에 대해서 작성해 보려고 한다. Pre-commit 이란?pre-commit는 Git에서 훅을 관리하고 실행하기 위한 프레임 워크이다. 코드가 커밋되기 전에 자동으로 다양한 검사를 수행하여 코드 품질을 유지하고, 실수를 줄일 수 있도록 도와준다. 예를 들어, 코드 스타일 검사, 정적 분석, 테스트 실행 등을 자동으로 수행할 수 있게 도와준다. 왜 필요할까?프로젝트의 코드 품질을 유지하는 것은 매우 중요하다. 하지만 스타일 가이드만 예로 들어도 적절한 컨벤션과 스타일 가이드를 매번 확인하기..
GIT
프로젝트를 하면서 커밋 메시지에 오타가 있거나 내용을 빼먹고 이미 푸시까지 해버렸고 이런 실수는 프로젝트의 문서화와 이력 관리에 혼란을 줄 수 있기 때문에, 정확하게 수정하는 방법을 알고있어야한다. 프로젝트를 진행하면서 나 역시 간단한 오타, 내용의 누락 등 이 있었고 솔직히 이야기하면 굳이 수정해야하나? 라는 생각도 했었다. 하지만 명확하고 정확한 커밋은 팀원들이 변경사항을 이해하고 코드를 추적하는데 큰 도움이 된다. 잘못된 정보가 포함된 커밋 메시지는 혼란을 야기하고, 향후 문제를 진단하거나 해결하는데 어려움을 초래할 수 있다. 라는 이야기가 있어 작은 실수를 확실히 바로잡는게 중요하다고 생각하여 찾아보게 된 내용이다. 커밋 메시지 수정하기우선 바로 직전 메시지를 수정한다고 가정하고 진행해보도록하겠다..
GitHub는 소프트웨어 개발 프로젝트의 협업 도구로서 중추적인 역할을 한다. 특히, 여러 리포지토리를 관리하는 경우, 일관된 이슈 및 PR 템플릿과 라벨 설정은 프로젝트의 효율성을 크게 향상시킬 수 있다. 본 글에서는 이러한 설정을 손쉽게 복사하고 적용하는 방법과 Organization Repository에 Labels를 적용하는 방법에 대해서 정리해 보려고한다. 기본적으로 진행하기 전 리포지토리 생성을 해줘야한다. 이후, 블로그에서 진행되는 md 파일이나 json 파일은 개인 취향/프로젝트 규칙에 맞게 작성하면 좋을 것 같다. 이슈 템플릿 생성이슈 템플릿은 직업 리포지토리에 파일로 저장해서 진행할 수 있고, github의 도움을 받아서 진행할 수 있다. - 이부분에 관해서는 깃허브 페이지에 자세히..
feat : 새로운 기능 추가 fix : 버그 수정 docs : 문서 관련, documentation 변경 style : 스타일 변경 - 코드 의미에 영향을 주지 않는, 코드가 아닌 스타일에 관련된 변경사항(포맷, 공백, 빼먹은 세미콜론, 함수 이름 변경, 줄간격, 파일 이름, 의미없는 주석 삭제) refactor : 코드 리팩토링 - 리팩토링에 대한 커밋(버그를 수정하지 않고 기능을 추가하지 않는 코드 변경) test : 테스트 관련 코드 - 누락된 테스트 추가 또는 기존 테스트 수정 build : 빌드 관련 파일 수정 ci : CI 설정 파일 수정 perf : 성능 개선 chore : 그 외 자잘한 수정 출처 Git commit 메시지 컨벤션 📩 commit 메시지를 잘 써야하는 이유? 개발하기도 힘..
깃 커밋 시 작성자 따로 커밋자 따로 커밋 깃허브를 보는데 내가 커밋한 내용이 author 따로 commit 따로 올라가는 상황이 발생하였다. 000 authored and 000 committed 부분이 문제가 되는 부분이다. 사진을 기준으로 위에가 정상적으로 커밋된 내용이고 아래쪽이 작성한 사람, 커밋한 사람 두 명이 공동으로 등록된 것이다. 기존의 잘못된 커밋들을 수정하는 방법도 있었지만 이미 끝난 프로젝트들이였고 혼자 작업한 내용들이어서 그렇게 큰 문제가 되지 않았기 때문에 기존 커밋들을 수정하진 않았지만 필요하다면 아래 글을 참고하면 좋을 것 같다. - 잔디가 공동으로 커밋이 되면 잔디도 안심겨지긴 하지만 잔디에 그렇게 연연하지 않기 때문에 신경 쓰지 않았다. Github 여러 Commit의 A..
