일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | 7 |
8 | 9 | 10 | 11 | 12 | 13 | 14 |
15 | 16 | 17 | 18 | 19 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 | 30 | 31 |
- tensorflow text
- Retry
- API Gateway
- hadoop
- subdag
- XAI
- 공분산
- BigQuery
- correlation
- Airflow
- session 유지
- chatGPT
- spark udf
- grad-cam
- login crawling
- integrated gradient
- requests
- TensorFlow
- top_k
- GCP
- flask
- API
- UDF
- youtube data
- 유튜브 API
- gather_nd
- airflow subdag
- Counterfactual Explanations
- GenericGBQException
- 상관관계
- Today
- Total
데이터과학 삼학년
[GitHub] GitHub에서 Pull Request(PR) 템플릿 사용 본문
- GitHub에서 Pull Request를 생성할 때 템플릿을 사용하면 효과적으로 커뮤니케이션을 할 수 있고, 프로젝트의 품질을 높일 수 있다.
간단한 template 파일을 만들어 놓으면 PR 요청시 해당 template이 자동으로 로드되어 아주...편하게(?) 사용하는 방법을 공유한다!
1. PR 템플릿 생성
- 프로젝트 루트 디렉토리에 .github 디렉토리를 만들고, 그 안에 PULL_REQUEST_TEMPLATE.md 파일을 생성
- 여기에 PR 템플릿 파일들을 추가할 수 있음 (여러개의 template 파일 선택 가능)
2. 템플릿 파일 작성
- PR을 오픈할 때 보여줄 템플릿을 작성
- Markdown 형식으로 작성하며, 필요에 따라 다양한 섹션을 추가 가능
- 예를 들어, 아래와 같은 템플릿 파일을 작성
## PR Checklist
Please check if your PR fulfills the following requirements:
- [ ] The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
## PR Type
What kind of change does this PR introduce?
<!-- Please check the one that applies to this PR using "x". -->
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] angular.io application / infrastructure changes
- [ ] Other... Please describe:
## What is the current behavior?
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
Issue Number: N/A
## What is the new behavior?
## Does this PR introduce a breaking change?
- [ ] Yes
- [ ] No
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
## Other information
"Breaking change"는 기존의 코드나 기능과 호환되지 않는 변경 사항을 의미
ㄴ Pull Request(PR)이 프로젝트에 대규모인 변경을 도입하는지 여부를 묻는 것
ㄴ 만약 해당 PR이 기존 코드나 기능을 파괴적으로 변경한다면 "Yes"를 선택하고, 그렇지 않다면 "No"를 선택
3. PR 생성 및 확인
- PR을 생성할 때, GitHub은 자동으로 해당 디렉토리에서 사용 가능한 템플릿을 감지
- 따라서 PR을 생성하면 사용할 템플릿을 선택할 수 있다!!!
4. 피드백 및 수정
- 다른 프로젝트 참여자들은 이 템플릿을 통해 제안한 변경에 대한 명확하고 일관된 정보를 제공
5. 다양한 템플릿 활용
- 여러 종류의 변경 사항에 따라 다양한 PR 템플릿을 생성할 수 있음
- 버그 수정, 문서 업데이트, 테스트 추가 등 각각의 경우에 적합한 템플릿을 활용하면 프로젝트 관리가 더욱 효율적으로 이루어질수 있음
'DevOps' 카테고리의 다른 글
Boilerplate template이란?! (0) | 2024.06.25 |
---|---|
[GitHub] PR 리뷰를 건설적이게!! (conventional commnet) (1) | 2024.06.10 |
[GitHub] git revert 와 reset의 차이 (0) | 2023.12.13 |
[Airflow] task, dag 우선순위 설정 (priority_weight) (0) | 2023.11.28 |
[Airflow] Sequential task loop로 연결하기 (0) | 2023.11.20 |