Commit 0538828fdd221b9886618f454e93a4239903daff
Exists in
spb-stable
and in
3 other branches
Merge branch 'master' of dev.gitlab.org:gitlab/gitlabhq
Showing
1 changed file
with
24 additions
and
20 deletions
Show diff stats
CONTRIBUTING.md
| @@ -48,7 +48,7 @@ Please send a merge request with a tested solution or a merge request with a fai | @@ -48,7 +48,7 @@ Please send a merge request with a tested solution or a merge request with a fai | ||
| 48 | 48 | ||
| 49 | ## Merge requests | 49 | ## Merge requests |
| 50 | 50 | ||
| 51 | -We welcome merge requests with fixes and improvements to GitLab code, tests, and/or documentation. The features we would really like a merge request for are listed with the [status 'accepting merge/merge requests' on our feedback forum](http://feedback.gitlab.com/forums/176466-general/status/796455) but other improvements are also welcome. | 51 | +We welcome merge requests with fixes and improvements to GitLab code, tests, and/or documentation. The features we would really like a merge request for are listed with the [status 'accepting merge requests' on our feedback forum](http://feedback.gitlab.com/forums/176466-general/status/796455) but other improvements are also welcome. If you want to add a new feature that is not marked it is best to first create a feedback issue (if there isn't one already) and leave a comment asking for it to be marked accepting merge requests. Please include screenshots or wireframes if the feature will also change the UI. |
| 52 | 52 | ||
| 53 | ### Merge request guidelines | 53 | ### Merge request guidelines |
| 54 | 54 | ||
| @@ -67,24 +67,28 @@ If you can, please submit a merge request with the fix or improvements including | @@ -67,24 +67,28 @@ If you can, please submit a merge request with the fix or improvements including | ||
| 67 | 1. Link relevant [issues](https://gitlab.com/gitlab-org/gitlab-ce/issues) and/or [feedback items](http://feedback.gitlab.com/) from the merge request description and leave a comment on them with a link back to the MR | 67 | 1. Link relevant [issues](https://gitlab.com/gitlab-org/gitlab-ce/issues) and/or [feedback items](http://feedback.gitlab.com/) from the merge request description and leave a comment on them with a link back to the MR |
| 68 | 1. Be prepared to answer questions and incorporate feedback even if requests for this arrive weeks or months after your MR submittion | 68 | 1. Be prepared to answer questions and incorporate feedback even if requests for this arrive weeks or months after your MR submittion |
| 69 | 69 | ||
| 70 | +The **official merge window** is in the beginning of the month from the 1st to the 7th day of the month. The best time to submit a MR and get feedback fast. Before this time the GitLab.com team is still dealing with work that is created by the monthly release such as assisting subscribers with upgrade issues, the release of Enterprise Edition and the upgrade of GitLab Cloud. After the 7th it is already getting closer to the release date of the next version. This means there is less time to fix the issues created by merging large new features. | ||
| 71 | + | ||
| 70 | Please keep the change in a single MR **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 MR is the more likely it is it will be merged, after that you can send more MR's to enhance it. | 72 | Please keep the change in a single MR **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 MR is the more likely it is it will be merged, after that you can send more MR's to enhance it. |
| 71 | 73 | ||
| 72 | -The **official merge window** is in the beginning of the month from the 1st to the 7th day of the month. | ||
| 73 | -The best time to submit a MR and get feedback fast. | ||
| 74 | -Before this time the GitLab.com team is still dealing with work that is created by the monthly release such as assisting subscribers with upgrade issues, the release of Enterprise Edition and the upgrade of GitLab Cloud. | ||
| 75 | -After the 7th it is already getting closer to the release date of the next version. | ||
| 76 | -This means there is less time to fix the issues created by merging large new features. | ||
| 77 | - | ||
| 78 | -We will accept a merge requests if it: | ||
| 79 | - | ||
| 80 | -* Includes proper tests and all tests pass (unless it contains a test exposing a bug in existing code) | ||
| 81 | -* Can be merged without problems (if not please use: `git rebase master`) | ||
| 82 | -* Do not break any existing functionality | ||
| 83 | -* 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 | ||
| 84 | -* Fixes one specific issue or implements one specific feature (do not combine things, send separate merge requests if needed) | ||
| 85 | -* Keeps the GitLab code base clean and well structured | ||
| 86 | -* Contains functionality we think other users will benefit from too | ||
| 87 | -* Doesn't add configuration options since these complicate future changes | ||
| 88 | -* Contains a single commit (please use `git rebase -i` to squash commits) | ||
| 89 | - | ||
| 90 | -For examples of feedback on merge requests please look at already [closed merge requests](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests?assignee_id=&label_name=&milestone_id=&scope=&sort=&state=closed). | 74 | +For examples of feedback on merge requests please look at already [closed merge requests](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests?assignee_id=&label_name=&milestone_id=&scope=&sort=&state=closed). Please ensure that your merge request meets the following contribution acceptance criteria. |
| 75 | + | ||
| 76 | +## Contribution acceptance criteria | ||
| 77 | + | ||
| 78 | +1. The change is as small as possible (see the above paragraph for details) | ||
| 79 | +1. Include proper tests and make all tests pass (unless it contains a test exposing a bug in existing code) | ||
| 80 | +1. Can merge without problems (if not please use: `git rebase master`) | ||
| 81 | +1. Does not break any existing functionality | ||
| 82 | +1. Fixes one specific issue or implements one specific feature (do not combine things, send separate merge requests if needed) | ||
| 83 | +1. Keeps the GitLab code base clean and well structured | ||
| 84 | +1. Contains functionality we think other users will benefit from too | ||
| 85 | +1. Doesn't add configuration options since they complicate future changes | ||
| 86 | +1. Contains a single commit (please use `git rebase -i` to squash commits) | ||
| 87 | +1. It conforms to the following style guides | ||
| 88 | + | ||
| 89 | +## Style guides | ||
| 90 | + | ||
| 91 | +1. [Ruby style guide](https://github.com/bbatsov/ruby-style-guide) | ||
| 92 | +1. [Rails style guide](https://github.com/bbatsov/rails-style-guide) | ||
| 93 | +1. [CoffeeScript style guide](https://github.com/polarmobile/coffeescript-style-guide) | ||
| 94 | +1. [Shell command guidelines](doc/development/shell_commands.md) |