From 6233e760eb3833b33f2de00a698e2df01e35f6e0 Mon Sep 17 00:00:00 2001 From: Roman Telezhynskyi Date: Sun, 5 Jun 2016 14:06:04 +0300 Subject: [PATCH] The bitbucket plugin doesn't support links, so better to make normal guide. --HG-- branch : develop --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d62e24730..63d99a8c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,2 +1,30 @@ -# Making pull requests -Please, visit page https://wiki.valentinaproject.org/wiki/Hacking:Making_pull_requests in Wiki. +# Before pull request + +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 + +First you should know little bit about our workflow. Right now we work with several named branches (https://www.mercurial-scm.org/wiki/NamedBranches). + +* *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. + +## 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. ". 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.