Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Léo-Paul Géneau
gitlab-ce
Commits
38c29f87
Commit
38c29f87
authored
May 04, 2017
by
Rémy Coutable
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improving copy of CONTRIBUTING.md, PROCESS.md, and code_review.md
Signed-off-by:
Rémy Coutable
<
remy@rymai.me
>
parent
cb87903c
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
11 additions
and
17 deletions
+11
-17
CONTRIBUTING.md
CONTRIBUTING.md
+10
-13
PROCESS.md
PROCESS.md
+1
-1
doc/development/code_review.md
doc/development/code_review.md
+0
-3
No files found.
CONTRIBUTING.md
View file @
38c29f87
...
@@ -136,7 +136,7 @@ and ~"direction".
...
@@ -136,7 +136,7 @@ and ~"direction".
A number of type labels have a priority assigned to them, which automatically
A number of type labels have a priority assigned to them, which automatically
makes them float to the top, depending on their importance.
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).
already reserved for subject labels).
The descriptions on the
[
labels page
][
labels-page
]
explain what falls under each type label.
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.
...
@@ -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,
Examples of subject labels are ~wiki, ~"container registry", ~ldap, ~api,
~issues, ~"merge requests", ~labels, and ~"container registry".
~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.)
### Team labels (~CI, ~Discussion, ~Edge, ~Frontend, ~Platform, etc.)
...
@@ -167,8 +167,8 @@ The current team labels are ~Build, ~CI, ~Discussion, ~Documentation, ~Edge,
...
@@ -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
The descriptions on the
[
labels page
][
labels-page
]
explain what falls under the
responsibility of each team.
responsibility of each team.
Team labels are always c
olored aqua, and are capitalized so that they show up as
Team labels are always c
apitalized so that they show up as the first label for
the first label for
any issue.
any issue.
### Priority labels (~Deliverable and ~Stretch)
### Priority labels (~Deliverable and ~Stretch)
...
@@ -255,12 +255,9 @@ every quarter.
...
@@ -255,12 +255,9 @@ every quarter.
The most important thing is making sure valid issues receive feedback from the
The most important thing is making sure valid issues receive feedback from the
development team. Therefore the priority is mentioning developers that can help
development team. Therefore the priority is mentioning developers that can help
on those issues. Please select someone with relevant experience from
on those issues. Please select someone with relevant experience from the
[
GitLab team
][
team
]
. If there is nobody mentioned with that expertise
[
GitLab team
][
team
]
. If there is nobody mentioned with that expertise look in
look in the commit history for the affected files to find someone. Avoid
the commit history for the affected files to find someone.
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.
[
described in our handbook
]:
https://about.gitlab.com/handbook/engineering/issues/issue-triage-policies/
[
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
[
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.
...
@@ -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.
[
Unit and system tests
][
testing
]
that pass on the CI server
1.
Performance/scalability implications have been considered, addressed, and tested
1.
Performance/scalability implications have been considered, addressed, and tested
1.
[
Documented
][
doc-styleguide
]
in the
`/doc`
directory
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.
Reviewed and any concerns are addressed
1.
Merged by a project maintainer
1.
Merged by a project maintainer
1.
Added to the release blog article 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.
Added to
[
the website
](
https://gitlab.com/gitlab-com/www-gitlab-com/
)
,
if relevant
1.
Community questions answered
1.
Community questions answered
1.
Answers to questions radiated (in docs/wiki/support etc.)
1.
Answers to questions radiated (in docs/wiki/support etc.)
...
...
PROCESS.md
View file @
38c29f87
## GitLab Core Team & GitLab Inc.
Team Contributing
Process
## GitLab Core Team & GitLab Inc.
Contribution
Process
---
---
...
...
doc/development/code_review.md
View file @
38c29f87
...
@@ -95,8 +95,6 @@ experience, refactors the existing code). Then:
...
@@ -95,8 +95,6 @@ experience, refactors the existing code). Then:
"LGTM :thumbsup:", or "Just a couple things to address."
"LGTM :thumbsup:", or "Just a couple things to address."
-
Assign the merge request to the author if changes are required following your
-
Assign the merge request to the author if changes are required following your
review.
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.
-
Set the milestone before merging a merge request.
-
Avoid accepting a merge request before the job succeeds. Of course, "Merge
-
Avoid accepting a merge request before the job succeeds. Of course, "Merge
When Pipeline Succeeds" (MWPS) is fine.
When Pipeline Succeeds" (MWPS) is fine.
...
@@ -105,7 +103,6 @@ experience, refactors the existing code). Then:
...
@@ -105,7 +103,6 @@ experience, refactors the existing code). Then:
-
Consider using the
[
Squash and
-
Consider using the
[
Squash and
merge
][
squash-and-merge
]
feature when the merge request has a lot of commits.
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
[
squash-and-merge
]:
https://docs.gitlab.com/ee/user/project/merge_requests/squash_and_merge.html#squash-and-merge
### The right balance
### The right balance
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment