summaryrefslogtreecommitdiff
path: root/doc/development
diff options
context:
space:
mode:
authorNick Thomas <nick@gitlab.com>2018-10-16 10:39:01 +0100
committerNick Thomas <nick@gitlab.com>2018-10-16 11:15:43 +0100
commitd5ef55976a0166712a692ee1785412d7f7901273 (patch)
tree4a111c2df2b615f22c6883c66f0e8fdd57d6882f /doc/development
parente657c9a9e6d9877a4bf0b3fb39a0f4bff0dc5470 (diff)
downloadgitlab-ce-d5ef55976a0166712a692ee1785412d7f7901273.tar.gz
When to create follow-up technical debt issues
Diffstat (limited to 'doc/development')
-rw-r--r--doc/development/contributing/issue_workflow.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/development/contributing/issue_workflow.md b/doc/development/contributing/issue_workflow.md
index c0a635db12f..d302065347e 100644
--- a/doc/development/contributing/issue_workflow.md
+++ b/doc/development/contributing/issue_workflow.md
@@ -315,6 +315,28 @@ for a release by the appropriate person.
Make sure to mention the merge request that the ~"technical debt" issue or
~"UX debt" issue is associated with in the description of the issue.
+## Technical debt in follow-up issues
+
+It's common to discover technical debt during development of a new feature. In
+the spirit of "minimum viable change", resolution is often deferred to a
+follow-up issue. However, this has limited value unless a commitment to address
+the debt is made. As technical debt reduces development velocity, it's important
+to keep it under control.
+
+Before accepting resolution of technical debt in a follow-up issue, maintainers
+should check that that fix is not trivial, and that the contributor (or their
+team) can commit to scheduling the issue within the next 3 releases.
+
+Trivial fixes can - and should - be addressed within the same MR.
+
+If a commitment to address the issue in the foreseeable future cannot be found,
+the maintainer must make a value judgement on whether the problem deserves an
+issue at all. If the commitment is lacking because the issue is neither trivial
+nor valuable, then perhaps no issue needs to be made after all. If a commitment
+is lacking because technical debt is being unfairly neglected, then maintainers
+should generally insist on resolution of the issue upfront, to protect
+development velocity.
+
## Stewardship
For issues related to the open source stewardship of GitLab,