Difference between revisions of "Hacking:Making pull requests"

From Seamly2D
Jump to: navigation, search
(Created page with "This page describes how to create a pull request. We highly recommend you to read this page before you will decide to send us your changes. '''Note:''' this is not a mercuria...")
 
Line 18: Line 18:
 
** For very small/trivial patches (contains only one commit) use the '''develop''' named branch directly.
 
** For very small/trivial patches (contains only one commit) use the '''develop''' named branch directly.
 
** 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.
 
** 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.
* 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.
+
* 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.
 
* Don't forget to add your changes to file ChangeLog.txt.
 
* Merge your '''develop'''/'''feature''' branch with '''develop''' branch.  
 
* Merge your '''develop'''/'''feature''' branch with '''develop''' branch.  
  
 
Most likely we will ask you to fix some issues in a code. In this case you will add your changes to the '''feature''' branch and update your pull request. No need to create new one each time.
 
Most likely we will ask you to fix some issues in a code. In this case you will add your changes to the '''feature''' branch and update your pull request. No need to create new one each time.

Revision as of 18:35, 2 June 2016

This page describes how to create a pull request. We highly recommend you to read this page before you will decide to send us your changes.

Note: this is not a mercurial tutorial. For a decent mercurial tutorial, try reading Mercurial: The Definitive Guide.

First you should know little bit about our workflow. Right now we work with several named branches.

  • default - used only for releases.
  • 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.

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.

There are several things you should know for successful creating a pull request.

  • Please, read carefully official tutorial from Atlassian Making a Pull Request.
  • 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.
    • 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.
  • 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 Resolving issues automatically when push code.
  • Don't forget to add your changes to file ChangeLog.txt.
  • Merge your develop/feature branch with develop branch.

Most likely we will ask you to fix some issues in a code. In this case you will add your changes to the feature branch and update your pull request. No need to create new one each time.