diff options
Diffstat (limited to 'doc/development/contributing')
| -rw-r--r-- | doc/development/contributing/issue_workflow.md | 24 | ||||
| -rw-r--r-- | doc/development/contributing/merge_request_workflow.md | 13 | ||||
| -rw-r--r-- | doc/development/contributing/style_guides.md | 4 |
3 files changed, 27 insertions, 14 deletions
diff --git a/doc/development/contributing/issue_workflow.md b/doc/development/contributing/issue_workflow.md index f32400d44a2..a385a7dc83a 100644 --- a/doc/development/contributing/issue_workflow.md +++ b/doc/development/contributing/issue_workflow.md @@ -40,17 +40,17 @@ scheduling into milestones. Labelling is a task for everyone. Most issues will have labels for at least one of the following: -- Type: ~feature, ~bug, ~backstage, etc. -- Stage: ~"devops::plan", ~"devops::create", etc. -- Group: ~"group::source code", ~"group::knowledge", ~"group::editor", etc. -- Category: ~"Category:Code Analytics", ~"Category:DevOps Score", ~"Category:Templates", etc. -- Feature: ~wiki, ~ldap, ~api, ~issues, ~"merge requests", etc. -- Department: ~UX, ~Quality -- Team: ~"Technical Writing", ~Delivery -- Specialization: ~frontend, ~backend, ~documentation -- Release Scoping: ~Deliverable, ~Stretch, ~"Next Patch Release" -- Priority: ~P1, ~P2, ~P3, ~P4 -- Severity: ~S1, ~S2, ~S3, ~S4 +- Type: `~feature`, `~bug`, `~backstage`, etc. +- Stage: `~"devops::plan"`, `~"devops::create"`, etc. +- Group: `~"group::source code"`, `~"group::knowledge"`, `~"group::editor"`, etc. +- Category: `~"Category:Code Analytics"`, `~"Category:DevOps Score"`, `~"Category:Templates"`, etc. +- Feature: `~wiki`, `~ldap`, `~api`, `~issues`, `~"merge requests"`, etc. +- Department: `~UX`, `~Quality` +- Team: `~"Technical Writing"`, `~Delivery` +- Specialization: `~frontend`, `~backend`, `~documentation` +- Release Scoping: `~Deliverable`, `~Stretch`, `~"Next Patch Release"` +- Priority: `~P1`, `~P2`, `~P3`, `~P4` +- Severity: ~`S1`, `~S2`, `~S3`, `~S4` All labels, their meaning and priority are defined on the [labels page](https://gitlab.com/gitlab-org/gitlab-foss/-/labels). @@ -210,7 +210,7 @@ If you are an expert in a particular area, it makes it easier to find issues to work on. You can also subscribe to those labels to receive an email each time an issue is labeled with a feature label corresponding to your expertise. -Examples of feature labels are ~wiki, ~ldap, ~api, ~issues, ~"merge requests" etc. +Examples of feature labels are `~wiki`, `~ldap`, `~api`, `~issues`, `~"merge requests"` etc. #### Naming and color convention diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index 510e90524ed..e839ae0ea3a 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -248,3 +248,16 @@ request: 1. The [GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit). 1. The [CI environment preparation](https://gitlab.com/gitlab-org/gitlab/blob/master/scripts/prepare_build.sh). 1. The [Omnibus package creator](https://gitlab.com/gitlab-org/omnibus-gitlab). + +### Incremental improvements + +We allow engineering time to fix small problems (with or without an +issue) that are incremental improvements, such as: + +1. Unprioritized bug fixes (e.g. [Banner alerting of project move is +showing up everywhere](https://gitlab.com/gitlab-org/gitlab/merge_requests/18985)) +1. Documentation improvements +1. Rubocop or Code Quality improvements + +Tag a merge request with ~"Stuff that should Just Work" to track work in +this area. diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index f825b3d7088..d53675cc716 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -40,8 +40,8 @@ This saves you time as you don't have to wait for the same errors to be detected [rss-source]: https://github.com/rubocop-hq/ruby-style-guide/blob/master/README.adoc#source-code-layout [rss-naming]: https://github.com/rubocop-hq/ruby-style-guide/blob/master/README.adoc#naming-conventions [doc-guidelines]: ../documentation/index.md "Documentation guidelines" -[js-styleguide]: ../fe_guide/style_guide_js.md "JavaScript styleguide" -[scss-styleguide]: ../fe_guide/style_guide_scss.md "SCSS styleguide" +[js-styleguide]: ../fe_guide/style/javascript.md "JavaScript styleguide" +[scss-styleguide]: ../fe_guide/style/scss.md "SCSS styleguide" [newlines-styleguide]: ../newlines_styleguide.md "Newlines styleguide" [testing]: ../testing_guide/index.md [us-english]: https://en.wikipedia.org/wiki/American_English |