diff options
author | Rémy Coutable <remy@rymai.me> | 2016-03-01 16:19:17 +0100 |
---|---|---|
committer | Rémy Coutable <remy@rymai.me> | 2016-03-01 16:19:17 +0100 |
commit | 64fc99fab6e8711fab5f67caedec262f8d728f0e (patch) | |
tree | cac10512c095a7fa29673dbc309c717324a024e8 | |
parent | 480e33fa8d6c46db55e4f24caddbf8bacae120fc (diff) | |
download | gitlab-ce-document-design-to-development-process.tar.gz |
Fix TocDoc in Contributing.md and other fixes following feedbacksdocument-design-to-development-process
-rw-r--r-- | CONTRIBUTING.md | 50 | ||||
-rw-r--r-- | PROCESS.md | 6 |
2 files changed, 29 insertions, 27 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ed39bea481..714701e7345 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,27 +3,27 @@ **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - [Contribute to GitLab](#contribute-to-gitlab) - - [Contributor license agreement](#contributor-license-agreement) - - [Security vulnerability disclosure](#security-vulnerability-disclosure) - - [Closing policy for issues and merge requests](#closing-policy-for-issues-and-merge-requests) - - [Helping others](#helping-others) - - [I want to contribute!](#i-want-to-contribute) - - [Implement design & UI elements](#implement-design-&-ui-elements) - - [Design reference](#design-reference) - - [UI development kit](#ui-development-kit) - - [Issue tracker](#issue-tracker) - - [Feature proposals](#feature-proposals) - - [Issue tracker guidelines](#issue-tracker-guidelines) - - [Issue weight](#issue-weight) - - [Regression issues](#regression-issues) - - [Merge requests](#merge-requests) - - [Merge request guidelines](#merge-request-guidelines) - - [Merge request description format](#merge-request-description-format) - - [Contribution acceptance criteria](#contribution-acceptance-criteria) - - [Changes for Stable Releases](#changes-for-stable-releases) - - [Definition of done](#definition-of-done) - - [Style guides](#style-guides) - - [Code of conduct](#code-of-conduct) + - [Contributor license agreement](#contributor-license-agreement) + - [Security vulnerability disclosure](#security-vulnerability-disclosure) + - [Closing policy for issues and merge requests](#closing-policy-for-issues-and-merge-requests) + - [Helping others](#helping-others) + - [I want to contribute!](#i-want-to-contribute) + - [Implement design & UI elements](#implement-design-ui-elements) + - [Design reference](#design-reference) + - [UI development kit](#ui-development-kit) + - [Issue tracker](#issue-tracker) + - [Feature proposals](#feature-proposals) + - [Issue tracker guidelines](#issue-tracker-guidelines) + - [Issue weight](#issue-weight) + - [Regression issues](#regression-issues) + - [Merge requests](#merge-requests) + - [Merge request guidelines](#merge-request-guidelines) + - [Merge request description format](#merge-request-description-format) + - [Contribution acceptance criteria](#contribution-acceptance-criteria) + - [Changes for Stable Releases](#changes-for-stable-releases) + - [Definition of done](#definition-of-done) + - [Style guides](#style-guides) + - [Code of conduct](#code-of-conduct) <!-- END doctoc generated TOC please keep comment here to allow auto update --> @@ -319,14 +319,13 @@ is it will be merged (quickly). After that you can send more MRs to enhance it. For examples of feedback on merge requests please look at already [closed merge requests][closed-merge-requests]. If you would like quick feedback -on your merge request feel free to mention one of the Merge Marshalls of the +on your merge request feel free to mention one of the Merge Marshalls in the [core team][core-team] or one of the -[Merge request coach](https://about.gitlab.com/team/). +[Merge request coaches](https://about.gitlab.com/team/). Please ensure that your merge request meets the contribution acceptance criteria. When having your code reviewed and when reviewing merge requests please take the -[thoughtbot code review guidelines](https://github.com/thoughtbot/guides/tree/master/code-review) -into account. +[Thoughtbot code review guide] into account. ### Merge request description format @@ -497,3 +496,4 @@ available at [http://contributor-covenant.org/version/1/1/0/](http://contributor [gitlab-design]: https://gitlab.com/gitlab-org/gitlab-design [free Antetype viewer (Mac OSX only)]: https://itunes.apple.com/us/app/antetype-viewer/id824152298?mt=12 [`gitlab1.atype` file]: https://gitlab.com/gitlab-org/gitlab-design/tree/master/gitlab1.atype/ +[Thoughtbot code review guide]: https://github.com/thoughtbot/guides/tree/master/code-review diff --git a/PROCESS.md b/PROCESS.md index 6bfe4374a7c..3e08e1f3b88 100644 --- a/PROCESS.md +++ b/PROCESS.md @@ -34,7 +34,7 @@ etc.). - Mark merge requests `Ready for Merge` when they meet the [contribution acceptance criteria] - Mention developer(s) based on the - [list of members and their specialities][core-team] + [list of members and their specialities][team] - Closes merge requests with no feedback from the reporter for two weeks ## Priorities of the issue team @@ -69,7 +69,8 @@ to add details to the issue. - We need to let issues stay in sync with the MR's. We can do this with a "Closing #XXXX" or "Fixes #XXXX" comment in the MR. We can't close the issue when there is a merge request because sometimes a MR is not good and we just close the MR, then the issue must stay. - *Developer*: needs help from a developer - *UX* needs needs help from a UX designer -- ~Frontend needs help from a Front-end engineer. Please follow the ["Implement design & UI elements" guidelines] contribution guidelines. +- ~Frontend needs help from a Front-end engineer. Please follow the + ["Implement design & UI elements" guidelines]. - *Graphics* needs help from a Graphics designer - *up-for-grabs* is an issue suitable for first-time contributors, of reasonable difficulty and size. Not exclusive with other labels. - *feature proposal* is a proposal for a new feature for GitLab. People are encouraged to vote @@ -169,6 +170,7 @@ Since this is an older issue I'll be closing this for now. If you think this is still an issue I encourage you to open it on the \[GitLab.com issue tracker\]\(https://gitlab.com/gitlab-org/gitlab-ce/issues). [core-team]: https://about.gitlab.com/core-team/ +[team]: https://about.gitlab.com/team/ [contribution acceptance criteria]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#contribution-acceptance-criteria ["Implement design & UI elements" guidelines]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md##implement-design-ui-elements [Thoughtbot code review guide]: https://github.com/thoughtbot/guides/tree/master/code-review |