Hacking:Making pull requests: Difference between revisions
Content deleted Content added
No edit summary |
No edit summary |
||
Line 8:
* ''develop'' - branch that contains a code for the next major release. Code in this branch good enough for testing and sharing among developers.
* ''feature'' - branch that contains a code for unfinished features.
* ''release'' - used for feature freeze state before the next major release. And for preparing the next minor release (feature freeze state).
These are the main branches you should know about. There are several long term task specific branches in repository too. But we will not discuss them in this document.
Line 16:
* Normally you are not allowed create new named branches. You should use '''develop''', '''feature''' or '''release''' depend on a purpose.
* Be sure you use correct branch for your changes. '''This is the most popular mistake'''.
** For very small/trivial patches (contains only one commit) use the '''develop''' named branch directly. If it's your first pull request better do it in '''feature''' branch.
** For regular patches (contains several commits) you should use the branch '''feature''' ('''recommended way'''). Don't worry if repository already contains one. We can have as many as we need. See [[Hacking:Tools#Mercurial|Mercurial useful commands]].
* Add correct description for your pull request. It should contain string "Resolved (or Fixed) issue #XXX. <Text of an issue description>". Where XXX is a number of issue in the Issue Tracker. Read more about [https://confluence.atlassian.com/bitbucket/resolve-issues-automatically-when-users-push-code-221451126.html Resolving issues automatically when push code].
* Don't forget to add your changes to file ChangeLog.txt.
Line 23:
* In a pull request merge your '''develop'''/'''feature''' branch with our '''develop''' branch.
* Don't need to close a named branch.
* If you want to update pull request (for example we have asked you to fix some issues) just push your changes to the same branch that was used in a pull request. Bitbucket will automatically update a pull request.
* If you want to make several pull requests per time return to develop branch and "reopen" another feature branch. ▼
* For fixing merge conflicts merge new code in '''develop/release''' branch -> to your '''feature''' branch.
▲* If you want to make several pull requests per time return to develop branch and "reopen" another feature branch. Repeat all previous steps.
''Little bonus. You can find all successfully merged pull requests [https://bitbucket.org/dismine/valentina/pull-requests/?state=MERGED here]. These are good example if you want to find how look correctly made pull requests.''
|