Download as
Browse Code »

Commit 49ad8f3b578205df7e0f83e41869f4cbb2694e78

Authored by dosire
1 parent 3d7edf0f
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

More hints for pull requests.

Showing 1 changed file with 7 additions and 4 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @49ad8f3
@@ -65,8 +65,13 @@ If you can, please submit a pull request with the fix or improvements including @@ -65,8 +65,13 @@ If you can, please submit a pull request with the fix or improvements including
65 1. Add your changes to the [CHANGELOG](CHANGELOG) 65 1. Add your changes to the [CHANGELOG](CHANGELOG)
66 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) 66 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)
67 1. Push the commit to your fork 67 1. Push the commit to your fork
68 -1. Submit a pull request  
69 -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 68 +1. Submit a pull request (PR)
  69 +1. The PR title should describes the change you want to make
  70 +1. The PR description should give a motive for your change and the method you used to achieve it
  71 +* If the PR changes the UI it should include before and after screenshots
  72 +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
  73 +
  74 +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.
70 75
71 We will accept pull requests if: 76 We will accept pull requests if:
72 77
@@ -74,11 +79,9 @@ We will accept pull requests if: @@ -74,11 +79,9 @@ We will accept pull requests if:
74 * It can be merged without problems (if not please use: `git rebase master`) 79 * It can be merged without problems (if not please use: `git rebase master`)
75 * It does not break any existing functionality 80 * It does not break any existing functionality
76 * 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 81 * 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
77 -* The description includes a motive for your change and the method you used to achieve it  
78 * It is not a catch all pull request but rather fixes a specific issue or implements a specific feature 82 * It is not a catch all pull request but rather fixes a specific issue or implements a specific feature
79 * It keeps the GitLab code base clean and well structured 83 * It keeps the GitLab code base clean and well structured
80 * We think other users will benefit from the same functionality 84 * We think other users will benefit from the same functionality
81 -* If it makes changes to the UI the pull request should include screenshots  
82 * It is a single commit (please use `git rebase -i` to squash commits) 85 * It is a single commit (please use `git rebase -i` to squash commits)
83 86
84 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). 87 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).