aw/valentina
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Roman Telezhynskyi 2020-01-30 16:55:06 +00:00
parent c8ade52309
commit 44f0bd5134
1 changed files with 5 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
CONTRIBUTING.md
View File

@ -2,29 +2,12 @@
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.
## Named branches
## Branches
First you should know little bit about our workflow. Right now we work with several named branches (https://www.mercurial-scm.org/wiki/NamedBranches).
First you should know little bit about our workflow.
* *default* - used only for releases.
* *master* - used only for major 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.
* *vz.y.x* - pattern for branch name, where z and y represents branch version. For example v0.6.x. Such branches will contain for stable versions. Look there for bugfixes for current stable version.
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.
## Check yourself
There are several things you should know for successful creating a pull request.
- Please, read carefully official tutorial from Atlassian Making a Pull Request (https://www.atlassian.com/git/tutorials/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 (https://confluence.atlassian.com/bitbucket/resolve-issues-automatically-when-users-push-code-221451126.html).
- Don't forget to add your changes to file ChangeLog.txt.
- Merge your **develop/feature** branch with **develop** branch.
# Reviewing
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.
You allowed to create a branch to later merge with develop branch.