diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc209c3cc87..d01e0407fda 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contribute to GitLab -This guide details how contribute to GitLab. - -If you want to know how the GitLab team handles contributions have a look at [the GitLab contributing process](PROCESS.md). +Thank you for your interest in contributing to GitLab. +This guide details how contribute to GitLab in a way that is efficient for everyone. +If you have read this guide and want to know how the GitLab core-team operates please see [the GitLab contributing process](PROCESS.md). ## Contributor license agreement @@ -77,7 +77,7 @@ The **official merge window** is in the beginning of the month from the 1st to t 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? Can you do part of the refactor? The increased reviewability of small MR's that leads to higher code quality is more important to us than having a mimimal commit log. The smaller a MR is the more likely it is it will be merged (quickly), after that you can send more MR's to enhance it. -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. +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). If you would like quick feedback on your merge request feel free to mention one of the Merge Marshalls of [the core-team](https://about.gitlab.com/core-team/). Please ensure that your merge request meets the following contribution acceptance criteria. **Please format your merge request description as follows:** @@ -103,11 +103,15 @@ For examples of feedback on merge requests please look at already [closed merge ## Style guides -1. [Ruby](https://github.com/bbatsov/ruby-style-guide) -1. [Rails](https://github.com/bbatsov/rails-style-guide) -1. [Formatting](https://github.com/thoughtbot/guides/tree/master/style#formatting) -1. [Naming](https://github.com/thoughtbot/guides/tree/master/style#naming) -1. [Testing](https://github.com/thoughtbot/guides/tree/master/style#testing) -1. [CoffeeScript](https://github.com/thoughtbot/guides/tree/master/style#coffeescript) -1. [Shell commands](doc/development/shell_commands.md) -1. [Markdown](http://www.cirosantilli.com/markdown-styleguide) +1. [Ruby](https://github.com/bbatsov/ruby-style-guide). + Important sections include [Source Code Layout](https://github.com/bbatsov/ruby-style-guide#source-code-layout) + and [Naming](https://github.com/bbatsov/ruby-style-guide#naming). Use: + - multi-line method chaining style **Option B**: dot `.` on previous line + - string literal quoting style **Option A**: single quoted by default +1. [Rails](https://github.com/bbatsov/rails-style-guide) +1. [Testing](https://github.com/thoughtbot/guides/tree/master/style#testing) +1. [CoffeeScript](https://github.com/thoughtbot/guides/tree/master/style#coffeescript) +1. [Shell commands](doc/development/shell_commands.md) created by GitLab contributors to enhance security +1. [Markdown](http://www.cirosantilli.com/markdown-styleguide) + +This is also the style used by linting tools such as [Rubocop](https://github.com/bbatsov/rubocop), PullReview[https://www.pullreview.com/] and [Hound CI](https://houndci.com). |