From 49ad8f3b578205df7e0f83e41869f4cbb2694e78 Mon Sep 17 00:00:00 2001 From: dosire Date: Tue, 17 Dec 2013 09:37:53 +0100 Subject: [PATCH] More hints for pull requests. --- CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62dc5d60b5f..778018d25ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,8 +65,13 @@ If you can, please submit a pull request with the fix or improvements including 1. Add your changes to the [CHANGELOG](CHANGELOG) 1. If you have multiple commits please combine them into one commit by [squashing them](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) 1. Push the commit to your fork -1. Submit a pull request -2. [Search for issues](https://github.com/gitlabhq/gitlabhq/search?q=&ref=cmdform&type=Issues) related to your pull request and mention them in the pull request description +1. Submit a pull request (PR) +1. The PR title should describes the change you want to make +1. The PR description should give a motive for your change and the method you used to achieve it +* If the PR changes the UI it should include before and after screenshots +1. [Search for issues](https://github.com/gitlabhq/gitlabhq/search?q=&ref=cmdform&type=Issues) related to your pull request and mention them in the pull request description + +Please keep the change in a single PR as small as possible. If you want to contribute a large feature think very hard what the minimum viable change is. Can you split functionality? Can you only submit the backend/API code? Can you start with a very simple UI? The smaller a PR is the more likely it is it will be merged, after that you can send more PR's to enhance it. We will accept pull requests if: @@ -74,11 +79,9 @@ We will accept pull requests if: * It can be merged without problems (if not please use: `git rebase master`) * It does not break any existing functionality * It's quality code that conforms to the [Ruby](https://github.com/bbatsov/ruby-style-guide) and [Rails](https://github.com/bbatsov/rails-style-guide) style guides and best practices -* The description includes a motive for your change and the method you used to achieve it * It is not a catch all pull request but rather fixes a specific issue or implements a specific feature * It keeps the GitLab code base clean and well structured * We think other users will benefit from the same functionality -* If it makes changes to the UI the pull request should include screenshots * It is a single commit (please use `git rebase -i` to squash commits) For examples of feedback on pull requests please look at already [closed pull requests](https://github.com/gitlabhq/gitlabhq/pulls?direction=desc&page=1&sort=created&state=closed).