Download as
Browse Code »

Commit fb3179006453a3ea3e38dd09abe0572e102e0d89

Authored by Ben Bodenmiller
1 parent 2e297c1e
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

update pull request guidelines, allow for submitting of tests that expose existing failures

Showing 1 changed file with 6 additions and 7 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @fb31790
... ... @@ -10,8 +10,7 @@ Issues and pull requests not in line with the guidelines listed in this document
10 10  
11 11 The [issue tracker](https://github.com/gitlabhq/gitlabhq/issues) is only for obvious bugs or misbehavior in the latest [stable or development release of GitLab](MAINTENANCE.md). When submitting an issue please conform to the issue submission guidelines listed below.
12 12  
13   -Do not use the issue tracker for feature requests. We have a specific
14   -[feedback and suggestions forum](http://feedback.gitlab.com) for this purpose.
  13 +Do not use the issue tracker for feature requests. We have a specific [feedback and suggestions forum](http://feedback.gitlab.com) for this purpose.
15 14  
16 15 Please send a pull request with a tested solution or a pull request with a failing test instead of opening an issue if you can. If you're unsure where to post, post to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) or [Stack Overflow](http://stackoverflow.com/questions/tagged/gitlab) first. There are a lot of helpful GitLab users there who may be able to help you quickly. If your particular issue turns out to be a bug, it will find its way from there.
17 16  
... ... @@ -33,11 +32,11 @@ Please send a pull request with a tested solution or a pull request with a faili
33 32  
34 33 ## Pull requests
35 34  
36   -We welcome pull request with improvements to GitLab code and/or documentation. The issues we would really like a pull request for are listed with the [status 'accepting merge/pull requests' on our feedback forum](http://feedback.gitlab.com/forums/176466-general/status/796455) but other improvements are also welcome.
  35 +We welcome pull requests with fixes and improvements to GitLab code, tests, and/or documentation. The features we would really like a pull request for are listed with the [status 'accepting merge/pull requests' on our feedback forum](http://feedback.gitlab.com/forums/176466-general/status/796455) but other improvements are also welcome.
37 36  
38 37 ### Pull request guidelines
39 38  
40   - If you can please submit a pull request with the fix including tests. The workflow to make a pull request is as follows:
  39 +If you can, please submit a pull request with the fix or improvements including tests. If you don't know how to fix the issue but can write a test that exposes the issue we will accept that as well. The workflow to make a pull request is as follows:
41 40  
42 41 1. Fork the project on GitHub
43 42 1. Create a feature branch
... ... @@ -45,17 +44,17 @@ We welcome pull request with improvements to GitLab code and/or documentation. T
45 44 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)
46 45 1. Push the commit to your fork
47 46 1. Submit a pull request
48   -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 comments
  47 +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
49 48  
50 49 We will accept pull requests if:
51 50  
52   -* The code has proper tests and all tests pass
  51 +* The code has proper tests and all tests pass (or it is a test exposing a failure in existing code)
53 52 * It can be merged without problems (if not please use: `git rebase master`)
54 53 * It doesn't break any existing functionality
55 54 * It's quality code that conforms to the [Rails style guide](https://github.com/bbatsov/rails-style-guide) and best practices
56 55 * The description includes a motive for your change and the method you used to achieve it
57 56 * It keeps the GitLab code base clean and well structured
58   -* We think other users will need the same functionality
  57 +* We think other users will benefit from the same functionality
59 58 * If it makes changes to the UI the pull request should include screenshots
60 59  
61 60 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).
... ...