How to make a clean Pull Request #827
Conversation
| @@ -0,0 +1,15 @@ | |||
| ### How to make a clean Pull Request: | |||
|
|
|||
| 1. Make sure your pull request has a correct title. For example in PlatformUI we use 'EZP-XXXXX: Title of the pull request' | |||
There was a problem hiding this comment.
A bugfix starts with "Fix EZP-42"
There was a problem hiding this comment.
For commits yes, but we don't typically add fix / improve in PR title.
There was a problem hiding this comment.
You are right. So a part explaining how to format your commit should be added. Maybe also explain how they should be split.
CONTRIBUTING.md
Outdated
| 1. Make sure your pull request has a correct title. For example in PlatformUI we use 'EZP-XXXXX: Title of the pull request' | ||
| 2. In the description of the pull request: | ||
| ⋅⋅* First add the JIRA link of your story. | ||
| ⋅⋅* Then add a short description about what's in the pull request. |
There was a problem hiding this comment.
if it's a bugfix explain why and how it fixes the issue.
CONTRIBUTING.md
Outdated
| ⋅⋅* Then add a short description about what's in the pull request. | ||
| ⋅⋅* Sometimes a screenshot, or a screencast is a good way to show your work. | ||
| ⋅⋅* Don't forget to mention if your code is tested (manual and unit tests, coverage...). | ||
| 3. Make a last check of the code you've just pushed, for example you can check: |
There was a problem hiding this comment.
should be done before the push.
There was a problem hiding this comment.
sure, but that's why it's a 'last' check... Anyway i'll add 'again at the end of the sentence.
StephaneDiot
force-pushed
the
HowToMakeACleanPR
branch
from
f065372
to
594f793
Compare
| @@ -0,0 +1,15 @@ | |||
| ### How to make a clean Pull Request: | |||
|
|
|||
| 1. Make sure your pull request has a correct title. For example in PlatformUI we use 'EZP-XXXXX: Title of the pull request' | |||
There was a problem hiding this comment.
You are right. So a part explaining how to format your commit should be added. Maybe also explain how they should be split.
| ⋅⋅* Then add a short description about what's in the pull request. If it's a bugfix explain why and how it fixes the issue. | ||
| ⋅⋅* Sometimes a screenshot, or a screencast is a good way to show your work. | ||
| ⋅⋅* Don't forget to mention if your code is tested (manual and unit tests, coverage...). | ||
| 3. Make a last check of the code you've just pushed, for example you can check again: |
There was a problem hiding this comment.
You added again but didn't explain it before.
So the first part of this doc should explain to create a branch containing the issue number.
Say that you should run unit test locally as explained in the README.md
|
Kudos, SonarCloud Quality Gate passed!
|
Description
As a punishment for being exceptionally late in one my
'slave''junior''lead printer' tasks, this is my 2 cents of contributing documentation on how to contribute and make a clean and pretty pull request.