Commit 04e77826ba6dc496a045f49cc83f3cc1d0dda11b
1 parent
f4e2865d
Exists in
master
and in
4 other branches
Notes about what PR's we would like to see.
Showing
1 changed file
with
3 additions
and
2 deletions
Show diff stats
CONTRIBUTING.md
@@ -36,7 +36,7 @@ We welcome pull requests with fixes and improvements to GitLab code, tests, and/ | @@ -36,7 +36,7 @@ We welcome pull requests with fixes and improvements to GitLab code, tests, and/ | ||
36 | 36 | ||
37 | ### Pull request guidelines | 37 | ### Pull request guidelines |
38 | 38 | ||
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: | 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. In general bug fixes that include a regression test are merged quickly while new features without proper tests are least likely to receive timely feedback. The workflow to make a pull request is as follows: |
40 | 40 | ||
41 | 1. Fork the project on GitHub | 41 | 1. Fork the project on GitHub |
42 | 1. Create a feature branch | 42 | 1. Create a feature branch |
@@ -51,10 +51,11 @@ We will accept pull requests if: | @@ -51,10 +51,11 @@ We will accept pull requests if: | ||
51 | * The code has proper tests and all tests pass (or it is a test exposing a failure in existing code) | 51 | * The code has proper tests and all tests pass (or it is a test exposing a failure in existing code) |
52 | * It can be merged without problems (if not please use: `git rebase master`) | 52 | * It can be merged without problems (if not please use: `git rebase master`) |
53 | * It doesn't break any existing functionality | 53 | * It doesn't break any existing functionality |
54 | -* It's quality code that conforms to the [Rails style guide](https://github.com/bbatsov/rails-style-guide) and best practices | 54 | +* 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 |
55 | * The description includes a motive for your change and the method you used to achieve it | 55 | * The description includes a motive for your change and the method you used to achieve it |
56 | * It keeps the GitLab code base clean and well structured | 56 | * It keeps the GitLab code base clean and well structured |
57 | * We think other users will benefit from the same functionality | 57 | * We think other users will benefit from the same functionality |
58 | * If it makes changes to the UI the pull request should include screenshots | 58 | * If it makes changes to the UI the pull request should include screenshots |
59 | +* It is a single commit (please use git rebase -i to squash commits) | ||
59 | 60 | ||
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). | 61 | 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). |