Download as
Browse Code »

Commit 3c053bdc20dd0e88d6fb8cddcaff1cd6332c1d0a

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

Add style guidelines in separte paragraph.

Showing 1 changed file with 20 additions and 15 deletions   Show diff stats
CONTRIBUTING.md
  Diff comments   View file @3c053bd
... ... @@ -67,18 +67,23 @@ If you can, please submit a merge request with the fix or improvements including
67 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 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   -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   -
72   -We will accept a merge requests if it:
73   -
74   -* Includes proper tests and all tests pass (unless it contains a test exposing a bug in existing code)
75   -* Can be merged without problems (if not please use: `git rebase master`)
76   -* Do not break any existing functionality
77   -* 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
78   -* Fixes one specific issue or implements one specific feature (do not combine things, send separate merge requests if needed)
79   -* Keeps the GitLab code base clean and well structured
80   -* Contains functionality we think other users will benefit from too
81   -* Doesn't add unnessecary configuration options since they complicate future changes
82   -* Contains a single commit (please use `git rebase -i` to squash commits)
83   -
84   -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).
  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. 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.
  71 +
  72 +## Contribution acceptance criteria
  73 +
  74 +1. Include proper tests and make all tests pass (unless it contains a test exposing a bug in existing code)
  75 +1. Can merge without problems (if not please use: `git rebase master`)
  76 +1. Does not break any existing functionality
  77 +1. Fixes one specific issue or implements one specific feature (do not combine things, send separate merge requests if needed)
  78 +1. Keeps the GitLab code base clean and well structured
  79 +1. Contains functionality we think other users will benefit from too
  80 +1. Doesn't add configuration options since they complicate future changes
  81 +1. Contains a single commit (please use `git rebase -i` to squash commits)
  82 +1. It conforms to the following style guides
  83 +
  84 +## Style guides
  85 +
  86 +1. [Ruby style guide](https://github.com/bbatsov/ruby-style-guide)
  87 +1. [Rails style guide](https://github.com/bbatsov/rails-style-guide)
  88 +1. [CoffeeScript style guide](https://github.com/polarmobile/coffeescript-style-guide)
  89 +1. [Shell command guidelines](doc/development/shell_commands.md)
... ...