summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGrzegorz Bizon <grzesiek.bizon@gmail.com>2016-03-17 07:56:23 +0100
committerGrzegorz Bizon <grzesiek.bizon@gmail.com>2016-03-17 08:01:13 +0100
commitf108cedf4a46ee0f6114a5a8584a6080f4346e5b (patch)
tree7df4af908fc40b6ed85adcec0861b7f547d6851c /CONTRIBUTING.md
parentc280edd31c6ab7f6eb757552d165efc69fcfbc9a (diff)
downloadgitlab-ce-f108cedf4a46ee0f6114a5a8584a6080f4346e5b.tar.gz
Add description of technical debt label in docs
[ci skip]
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7540fa1afcc..a946c2cd882 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,25 @@ 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 codebase, we created a
+*technical debt* label in [issue tracker of CE][ce-tracker].
+
+This label should be added to issues that describe things that can be improved,
+shortcuts that has 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 *technical debt* label, to make it easier to schedule the
+improvements for a release.
+
+Issues with *technical debt* label have a same priority like issues that
+describe a new features that can be introduced in GitLab, and should be
+scheduled for a release by appropriate person.
+
## Merge requests
We welcome merge requests with fixes and improvements to GitLab code, tests,