Jirka Borovec glenn-jocher pre-commit-ci[bot] commited on
Commit
dbbb57c
β€’
1 Parent(s): c43f135

GH: add PR template (#6482)

Browse files

* GH: add PR template

* Update CONTRIBUTING.md

* Update PULL_REQUEST_TEMPLATE.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md

Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Files changed (2) hide show
  1. .github/PULL_REQUEST_TEMPLATE.md +7 -0
  2. CONTRIBUTING.md +11 -11
.github/PULL_REQUEST_TEMPLATE.md ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ Thank you for submitting a YOLOv5 πŸš€ Pull Request! We want to make contributing to YOLOv5 as easy and transparent as possible. A few tips to get you started:
2
+
3
+ - Search existing YOLOv5 [PRs](https://github.com/ultralytics/yolov5/pull) to see if a similar PR already exists.
4
+ - Link this PR to a YOLOv5 [issue](https://github.com/ultralytics/yolov5/issues) to help us understand what bug fix or feature is being implemented.
5
+ - Provide before and after profiling/inference/training results to help us quantify the improvement your PR provides (if applicable).
6
+
7
+ Please see our βœ… [Contributing Guide](https://github.com/ultralytics/yolov5/blob/master/CONTRIBUTING.md) for more details.
CONTRIBUTING.md CHANGED
@@ -42,17 +42,17 @@ changes** button. All done, your PR is now submitted to YOLOv5 for review and ap
42
  To allow your work to be integrated as seamlessly as possible, we advise you to:
43
 
44
  - βœ… Verify your PR is **up-to-date with upstream/master.** If your PR is behind upstream/master an
45
- automatic [GitHub actions](https://github.com/ultralytics/yolov5/blob/master/.github/workflows/rebase.yml) rebase may
46
- be attempted by including the /rebase command in a comment body, or by running the following code, replacing 'feature'
47
- with the name of your local branch:
48
-
49
- ```bash
50
- git remote add upstream https://github.com/ultralytics/yolov5.git
51
- git fetch upstream
52
- git checkout feature # <----- replace 'feature' with local branch name
53
- git merge upstream/master
54
- git push -u origin -f
55
- ```
56
 
57
  - βœ… Verify all Continuous Integration (CI) **checks are passing**.
58
  - βœ… Reduce changes to the absolute **minimum** required for your bug fix or feature addition. _"It is not daily increase
 
42
  To allow your work to be integrated as seamlessly as possible, we advise you to:
43
 
44
  - βœ… Verify your PR is **up-to-date with upstream/master.** If your PR is behind upstream/master an
45
+ automatic [GitHub Actions](https://github.com/ultralytics/yolov5/blob/master/.github/workflows/rebase.yml) merge may
46
+ be attempted by writing /rebase in a new comment, or by running the following code, replacing 'feature' with the name
47
+ of your local branch:
48
+
49
+ ```bash
50
+ git remote add upstream https://github.com/ultralytics/yolov5.git
51
+ git fetch upstream
52
+ # git checkout feature # <--- replace 'feature' with local branch name
53
+ git merge upstream/master
54
+ git push -u origin -f
55
+ ```
56
 
57
  - βœ… Verify all Continuous Integration (CI) **checks are passing**.
58
  - βœ… Reduce changes to the absolute **minimum** required for your bug fix or feature addition. _"It is not daily increase