Skip to content
This repository has been archived by the owner on May 3, 2022. It is now read-only.

How to make a clean Pull Request #827

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −0
Open

How to make a clean Pull Request #827

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'
Copy link
Contributor

@yannickroger yannickroger Mar 27, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bugfix starts with "Fix EZP-42"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For commits yes, but we don't typically add fix / improve in PR title.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right. So a part explaining how to format your commit should be added. Maybe also explain how they should be split.

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. 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

⋅⋅* The coding standard errors like empty lines or missing / added spaces
⋅⋅* The naming. Begin you methods name by verbs (<verb>Something()). Try to be as descriptive as possible for your variables' name.
⋅⋅* Make sure all you methods are commented with up to date parameters and visibility of your methods
⋅⋅* Verify you don't have uneeded diff.
4. Check if ezrobot and Travis are ok.
5. Good job! You can now request a review!