diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-07-20 15:26:25 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-07-20 15:26:25 +0300 |
commit | a09983ae35713f5a2bbb100981116d31ce99826e (patch) | |
tree | 2ee2af7bd104d57086db360a7e6d8c9d5d43667a /doc/development/contributing | |
parent | 18c5ab32b738c0b6ecb4d0df3994000482f34bd8 (diff) |
Add latest changes from gitlab-org/gitlab@13-2-stable-ee
Diffstat (limited to 'doc/development/contributing')
-rw-r--r-- | doc/development/contributing/issue_workflow.md | 31 | ||||
-rw-r--r-- | doc/development/contributing/merge_request_workflow.md | 3 | ||||
-rw-r--r-- | doc/development/contributing/style_guides.md | 12 |
3 files changed, 23 insertions, 23 deletions
diff --git a/doc/development/contributing/issue_workflow.md b/doc/development/contributing/issue_workflow.md index f70299cbfc2..9feaa485bd2 100644 --- a/doc/development/contributing/issue_workflow.md +++ b/doc/development/contributing/issue_workflow.md @@ -81,7 +81,7 @@ already reserved for category labels). The descriptions on the [labels page](https://gitlab.com/groups/gitlab-org/-/labels) explain what falls under each type label. -The GitLab handbook documents [when something is a bug and when it is a feature request](https://about.gitlab.com/handbook/product/product-management/process/feature-or-bug.html). +The GitLab handbook documents [when something is a bug](https://about.gitlab.com/handbook/product/product-processes/#bug-issues) and [when it is a feature request](https://about.gitlab.com/handbook/product/product-processes/#feature-issues). ### Facet labels @@ -104,7 +104,7 @@ Following is a non-exhaustive list of facet labels: ### Stage labels -Stage labels specify which [stage](https://about.gitlab.com/handbook/product/categories/#hierarchy) the issue belongs to. +Stage labels specify which [stage](https://about.gitlab.com/handbook/product/product-categories/#hierarchy) the issue belongs to. #### Naming and color convention @@ -148,7 +148,7 @@ The current group labels can be found by [searching the labels list for `group:: These labels are [scoped labels](../../user/project/labels.md#scoped-labels-premium) and thus are mutually exclusive. -You can find the groups listed in the [Product Stages, Groups, and Categories](https://about.gitlab.com/handbook/product/categories/) page. +You can find the groups listed in the [Product Stages, Groups, and Categories](https://about.gitlab.com/handbook/product/product-categories/) page. We use the term group to map down product requirements from our product stages. As a team needs some way to collect the work their members are planning to be assigned to, we use the `~group::` labels to do so. @@ -167,7 +167,7 @@ Please read [Stage and Group labels in Throughput](https://about.gitlab.com/hand ### Category labels From the handbook's -[Product stages, groups, and categories](https://about.gitlab.com/handbook/product/categories/#hierarchy) +[Product stages, groups, and categories](https://about.gitlab.com/handbook/product/product-categories/#hierarchy) page: > Categories are high-level capabilities that may be a standalone product at @@ -199,7 +199,7 @@ in <https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/categories.yml ### Feature labels From the handbook's -[Product stages, groups, and categories](https://about.gitlab.com/handbook/product/categories/#hierarchy) +[Product stages, groups, and categories](https://about.gitlab.com/handbook/product/product-categories/#hierarchy) page: > Features: Small, discrete functionalities. e.g. Issue weights. Some common @@ -312,22 +312,13 @@ We want to avoid a situation when a contributor picks an because we realize that it does not fit our vision, or we want to solve it in a different way. -We add the ~"Accepting merge requests" label to: +We automatically add the ~"Accepting merge requests" label to issues +that match the [triage policy](https://about.gitlab.com/handbook/engineering/quality/triage-operations/#accepting-merge-requests). -- Low priority ~bug issues (i.e. we do not add it to the bugs that we want to - solve in the ~"Next Patch Release") -- Small ~feature -- Small ~"technical debt" issues - -After adding the ~"Accepting merge requests" label, we try to estimate the -[weight](#issue-weight) of the issue. We use issue weight to let contributors -know how difficult the issue is. Additionally: - -- We advertise [`Accepting merge requests` issues with weight < 5](https://gitlab.com/groups/gitlab-org/-/issues?state=opened&label_name[]=Accepting+merge+requests&assignee_id=None&sort=weight) - as suitable for people that have never contributed to GitLab before on the - [Up For Grabs campaign](https://up-for-grabs.net/#/) -- We encourage people that have never contributed to any open source project to - look for [`Accepting merge requests` issues with a weight of 1](https://gitlab.com/groups/gitlab-org/-/issues?state=opened&label_name[]=Accepting+merge+requests&assignee_id=None&sort=weight&weight=1) +We recommend people that have never contributed to any open source project to +look for issues labeled `~"Accepting merge requests"` with a [weight of 1](https://gitlab.com/groups/gitlab-org/-/issues?state=opened&label_name[]=Accepting+merge+requests&assignee_id=None&sort=weight&weight=1) or the `~"Good for 1st time contributors"` [label](https://gitlab.com/gitlab-org/gitlab/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=Good%20for%201st%20time%20contributors&assignee_id=None) attached to it. +More experienced contributors are very welcome to tackle +[any of them](https://gitlab.com/groups/gitlab-org/-/issues?state=opened&label_name[]=Accepting+merge+requests&assignee_id=None). If you've decided that you would like to work on an issue, please @-mention the [appropriate product manager](https://about.gitlab.com/handbook/product/#who-to-talk-to-for-what) diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index 14c6b0b1073..e5a8bdad7b0 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -119,8 +119,7 @@ document from the Kubernetes team also has some great points regarding this. When writing commit messages, please follow the guidelines below: - The commit subject must contain at least 3 words. -- The commit subject should ideally contain up to 50 characters, - and must not be longer than 72 characters. +- The commit subject must not be longer than 72 characters. - The commit subject must start with a capital letter. - The commit subject must not end with a period. - The commit subject and body must be separated by a blank line. diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index 9e4870eadc4..ed254052180 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -56,6 +56,16 @@ Additionally, we have a dedicated [newlines style guide](../newlines_styleguide.md), as well as dedicated [test-specific style guides and best practices](../testing_guide/index.md). +### Creating new RuboCop cops + +Typically it is better for the linting rules to be enforced programmatically as it +reduces the aforementioned [bike-shedding](https://en.wiktionary.org/wiki/bikeshedding). + +To that end, we encourage creation of new RuboCop rules in the codebase. + +When creating a new cop that could be applied to multiple applications, we encourage you +to add it to our [GitLab Styles](https://gitlab.com/gitlab-org/gitlab-styles) gem. + ## Database migrations See the dedicated [Database Migrations Style Guide](../migration_style_guide.md). @@ -82,7 +92,7 @@ See the dedicated [Shell scripting standards and style guidelines](../shell_scri ## Markdown -We're following [Ciro Santilli's Markdown Style Guide](https://cirosantilli.com/markdown-style-guide). +We're following [Ciro Santilli's Markdown Style Guide](https://cirosantilli.com/markdown-style-guide/). ## Documentation |