glenn-jocher
commited on
Commit
β’
3ce0db8
1
Parent(s):
d808855
Update CONTRIBUTING.md (#3645)
Browse files* Update CONTRIBUTING.md
* Update CONTRIBUTING.md
* Update CONTRIBUTING.md
* Update CONTRIBUTING.md
- CONTRIBUTING.md +22 -1
CONTRIBUTING.md
CHANGED
@@ -12,6 +12,25 @@ YOLOv5 works so well due to our combined community effort, and for every small i
|
|
12 |
|
13 |
|
14 |
## Submitting a Pull Request (PR) π οΈ
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
15 |
|
16 |
To allow your work to be integrated as seamlessly as possible, we advise you to:
|
17 |
- β
Verify your PR is **up-to-date with origin/master.** If your PR is behind origin/master an automatic [GitHub actions](https://github.com/ultralytics/yolov5/blob/master/.github/workflows/rebase.yml) rebase may be attempted by including the /rebase command in a comment body, or by running the following code, replacing 'feature' with the name of your local branch:
|
@@ -28,7 +47,9 @@ git push -u origin -f
|
|
28 |
|
29 |
## Submitting a Bug Report π
|
30 |
|
31 |
-
|
|
|
|
|
32 |
|
33 |
When asking a question, people will be better able to provide help if you provide **code** that they can easily understand and use to **reproduce** the problem. This is referred to by community members as creating a [minimum reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). Your code that reproduces the problem should be:
|
34 |
|
|
|
12 |
|
13 |
|
14 |
## Submitting a Pull Request (PR) π οΈ
|
15 |
+
Submitting a PR is easy! This example shows how to submit a PR for updating `requirements.txt` in 4 steps:
|
16 |
+
|
17 |
+
### 1. Select File to Update
|
18 |
+
Select `requirements.txt` to update by clicking on it in GitHub.
|
19 |
+
<img width="1000" alt="PR_step1" src="https://user-images.githubusercontent.com/26833433/122260847-08be2600-ced4-11eb-828b-8287ace4136c.png">
|
20 |
+
|
21 |
+
### 2. Click 'Edit this file'
|
22 |
+
Button is in top-right corner.
|
23 |
+
<img width="1000" alt="PR_step2" src="https://user-images.githubusercontent.com/26833433/122260844-06f46280-ced4-11eb-9eec-b8a24be519ca.png">
|
24 |
+
|
25 |
+
### 3. Make Changes
|
26 |
+
Change `matplotlib` version from `3.2.2` to `3.3`.
|
27 |
+
<img width="1000" alt="PR_step3" src="https://user-images.githubusercontent.com/26833433/122260853-0a87e980-ced4-11eb-9fd2-3650fb6e0842.png">
|
28 |
+
|
29 |
+
### 4. Preview Changes and Submit PR
|
30 |
+
Click on the **Preview changes** tab to verify your updates. At the bottom of the screen select 'Create a **new branch** for this commit', assign your branch a descriptive name such as `fix/matplotlib_version` and click the green **Propose changes** button. All done, your PR is now submitted to YOLOv5 for review and approval π!
|
31 |
+
<img width="1000" alt="PR_step4" src="https://user-images.githubusercontent.com/26833433/122260856-0b208000-ced4-11eb-8e8e-77b6151cbcc3.png">
|
32 |
+
|
33 |
+
### PR recommendations
|
34 |
|
35 |
To allow your work to be integrated as seamlessly as possible, we advise you to:
|
36 |
- β
Verify your PR is **up-to-date with origin/master.** If your PR is behind origin/master an automatic [GitHub actions](https://github.com/ultralytics/yolov5/blob/master/.github/workflows/rebase.yml) rebase may be attempted by including the /rebase command in a comment body, or by running the following code, replacing 'feature' with the name of your local branch:
|
|
|
47 |
|
48 |
## Submitting a Bug Report π
|
49 |
|
50 |
+
If you spot a problem with YOLOv5 please submit a Bug Report!
|
51 |
+
|
52 |
+
For us to start investigating a possibel problem we need to be able to reproduce it ourselves first. We've created a few short guidelines below to help users provide what we need in order to get started.
|
53 |
|
54 |
When asking a question, people will be better able to provide help if you provide **code** that they can easily understand and use to **reproduce** the problem. This is referred to by community members as creating a [minimum reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). Your code that reproduces the problem should be:
|
55 |
|