diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-03-23 14:14:38 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-03-23 14:14:38 +0000 |
| commit | 06976bf1c5a06df7677814894df62744050ad2c4 (patch) | |
| tree | 724415d0e2ee478e8458320294b62d1dd5e3e7e0 | |
| parent | a29c195423342709e541c7d480aba9dae17c34f6 (diff) | |
| parent | 691d5db5986f8f57d187d3da19c69ef92087fe75 (diff) | |
| download | gitlab-ce-06976bf1c5a06df7677814894df62744050ad2c4.tar.gz | |
Merge branch 'doc/technical-debt-label' into 'master'
Add description of technical debt label in docs
Description for a technical debt label and workflow, as discussed in https://dev.gitlab.org/gitlab/organization/issues/714.
See merge request !3265
| -rw-r--r-- | CONTRIBUTING.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7540fa1afcc..511336f384c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,7 @@ - [Issue tracker guidelines](#issue-tracker-guidelines) - [Issue weight](#issue-weight) - [Regression issues](#regression-issues) + - [Technical debt](#technical-debt) - [Merge requests](#merge-requests) - [Merge request guidelines](#merge-request-guidelines) - [Merge request description format](#merge-request-description-format) @@ -242,6 +243,28 @@ addressed. [8.3 Regressions]: https://gitlab.com/gitlab-org/gitlab-ce/issues/4127 [update the notes]: https://gitlab.com/gitlab-org/release-tools/blob/master/doc/pro-tips.md#update-the-regression-issue +### Technical debt + +In order to track things that can be improved in GitLab's codebase, we created +the ~"technical debt" label in [GitLab's issue tracker][ce-tracker]. + +This label should be added to issues that describe things that can be improved, +shortcuts that have been taken, code that needs refactoring, features that need +additional attention, and all other things that have been left behind due to +high velocity of development. + +Everyone can create an issue, though you may need to ask for adding a specific +label, if you do not have permissions to do it by yourself. Additional labels +can be combined with the `technical debt` label, to make it easier to schedule +the improvements for a release. + +Issues tagged with the `technical debt` label have the same priority like issues +that describe a new feature to be introduced in GitLab, and should be scheduled +for a release by the appropriate person. + +Make sure to mention the merge request that the `technical debt` issue is +associated with in the description of the issue. + ## Merge requests We welcome merge requests with fixes and improvements to GitLab code, tests, |