diff options
author | Rémy Coutable <remy@rymai.me> | 2017-05-04 09:02:39 +0200 |
---|---|---|
committer | Rémy Coutable <remy@rymai.me> | 2017-05-04 09:02:39 +0200 |
commit | 38c29f8775e393164e04fb1faf6c6b05fd105df6 (patch) | |
tree | 565a54ed85899b4bb8132a7c97e9fb17b410b862 | |
parent | cb87903c6eec14e42fc23e0488f6c0769ba627d9 (diff) | |
download | gitlab-ce-38c29f8775e393164e04fb1faf6c6b05fd105df6.tar.gz |
Improving copy of CONTRIBUTING.md, PROCESS.md, and code_review.mddocs/30141-improve-contributing-guide
Signed-off-by: Rémy Coutable <remy@rymai.me>
-rw-r--r-- | CONTRIBUTING.md | 23 | ||||
-rw-r--r-- | PROCESS.md | 2 | ||||
-rw-r--r-- | doc/development/code_review.md | 3 |
3 files changed, 11 insertions, 17 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f27efb0ae85..600dad563a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -136,7 +136,7 @@ and ~"direction". A number of type labels have a priority assigned to them, which automatically makes them float to the top, depending on their importance. -Type labels are always lowercase, but can have any color, besides blue (which is +Type labels are always lowercase, and can have any color, besides blue (which is already reserved for subject labels). The descriptions on the [labels page][labels-page] explain what falls under each type label. @@ -153,7 +153,7 @@ issue is labelled with a subject label corresponding to your expertise. Examples of subject labels are ~wiki, ~"container registry", ~ldap, ~api, ~issues, ~"merge requests", ~labels, and ~"container registry". -Subject labels are always colored blue and all-lowercase. +Subject labels are always all-lowercase. ### Team labels (~CI, ~Discussion, ~Edge, ~Frontend, ~Platform, etc.) @@ -167,8 +167,8 @@ The current team labels are ~Build, ~CI, ~Discussion, ~Documentation, ~Edge, The descriptions on the [labels page][labels-page] explain what falls under the responsibility of each team. -Team labels are always colored aqua, and are capitalized so that they show up as -the first label for any issue. +Team labels are always capitalized so that they show up as the first label for +any issue. ### Priority labels (~Deliverable and ~Stretch) @@ -255,12 +255,9 @@ every quarter. The most important thing is making sure valid issues receive feedback from the development team. Therefore the priority is mentioning developers that can help -on those issues. Please select someone with relevant experience from -[GitLab team][team]. If there is nobody mentioned with that expertise -look in the commit history for the affected files to find someone. Avoid -mentioning the lead developer, this is the person that is least likely to give a -timely response. If the involvement of the lead developer is needed the other -core team members will mention this person. +on those issues. Please select someone with relevant experience from the +[GitLab team][team]. If there is nobody mentioned with that expertise look in +the commit history for the affected files to find someone. [described in our handbook]: https://about.gitlab.com/handbook/engineering/issues/issue-triage-policies/ [issue bash events]: https://gitlab.com/gitlab-org/gitlab-ce/issues/17815 @@ -535,11 +532,11 @@ the feature you contribute through all of these steps. 1. [Unit and system tests][testing] that pass on the CI server 1. Performance/scalability implications have been considered, addressed, and tested 1. [Documented][doc-styleguide] in the `/doc` directory -1. [Changelog entry added][changelog] +1. [Changelog entry added][changelog], if necessary 1. Reviewed and any concerns are addressed 1. Merged by a project maintainer -1. Added to the release blog article if relevant -1. Added to [the website](https://gitlab.com/gitlab-com/www-gitlab-com/) if relevant +1. Added to the release blog article, if relevant +1. Added to [the website](https://gitlab.com/gitlab-com/www-gitlab-com/), if relevant 1. Community questions answered 1. Answers to questions radiated (in docs/wiki/support etc.) diff --git a/PROCESS.md b/PROCESS.md index 6d7d155ca6c..3b97a4e8c75 100644 --- a/PROCESS.md +++ b/PROCESS.md @@ -1,4 +1,4 @@ -## GitLab Core Team & GitLab Inc. Team Contributing Process +## GitLab Core Team & GitLab Inc. Contribution Process --- diff --git a/doc/development/code_review.md b/doc/development/code_review.md index 138817f5440..be3dd1e2cc6 100644 --- a/doc/development/code_review.md +++ b/doc/development/code_review.md @@ -95,8 +95,6 @@ experience, refactors the existing code). Then: "LGTM :thumbsup:", or "Just a couple things to address." - Assign the merge request to the author if changes are required following your review. -- You should try to resolve merge conflicts yourself, using the [merge conflict - resolution][conflict-resolution] tool. - Set the milestone before merging a merge request. - Avoid accepting a merge request before the job succeeds. Of course, "Merge When Pipeline Succeeds" (MWPS) is fine. @@ -105,7 +103,6 @@ experience, refactors the existing code). Then: - Consider using the [Squash and merge][squash-and-merge] feature when the merge request has a lot of commits. -[conflict-resolution]: https://docs.gitlab.com/ce/user/project/merge_requests/resolve_conflicts.html#merge-conflict-resolution [squash-and-merge]: https://docs.gitlab.com/ee/user/project/merge_requests/squash_and_merge.html#squash-and-merge ### The right balance |