From 3e0eb89b4001468512de60301752360edba2d57e Mon Sep 17 00:00:00 2001 From: Nick Thomas Date: Mon, 15 Aug 2016 22:17:44 +0100 Subject: [PATCH 1/2] Ask engineers to help triage issues when they have time --- .../engineering/issues/issue-triage-policies.html.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/source/handbook/engineering/issues/issue-triage-policies.html.md b/source/handbook/engineering/issues/issue-triage-policies.html.md index c28c23d3ac5..6ccfc25fef4 100644 --- a/source/handbook/engineering/issues/issue-triage-policies.html.md +++ b/source/handbook/engineering/issues/issue-triage-policies.html.md @@ -3,7 +3,9 @@ layout: markdown_page title: Issue Triage Policies --- -In order to keep the GitLab projects' issue trackers maintainable, the policies outlined below were created and will be enforced. +GitLab believes in [Open Development](open-development), and we encourage the community to file issues and open merge requests for our projects on [GitLab.com](https://gitlab.com/groups/gitlab-org). Their contributions are valuable, and we should aim to triage new issues as promptly as we can in recognition of this. + +Triage is something any engineer at GitLab can do. Keeping the number of untriaged issues low is essential for maintainability, and is our collective responsibility. Consider triaging a few [issues](untriaged-issues-query) around your other responsibilities, or scheduling some time for it on a regular basis. ## Policies @@ -59,6 +61,8 @@ The following projects, resources, and blog posts were very helpful in crafting - [My condolences, you’re now the maintainer of a popular open source project][my-condolences] - [The Art of Closing][art-of-closing] +[open-development]: https://about.gitlab.com/2015/12/16/improving-open-development-for-everyone/ +[untriaged-issues-query]: https://gitlab.com/gitlab-org/gitlab-ce/issues?scope=all&sort=updated_asc&state=opened&assignee_id=0&milestone_title=No+Milestone&label_name%5B%5D=No+Label&weight=No+Weight [17693]: https://gitlab.com/gitlab-org/gitlab-ce/issues/17693 [code-triage]: https://www.codetriage.com/ [open-source-gardener]: http://words.steveklabnik.com/how-to-be-an-open-source-gardener -- GitLab From d26e799ce62ecbdd2d12444bf88d8091676849c0 Mon Sep 17 00:00:00 2001 From: Nick Thomas Date: Fri, 19 Aug 2016 01:12:37 +0100 Subject: [PATCH 2/2] Add a short how-to-triage guide to the handbook --- .../issues/issue-triage-policies.html.md | 37 +++++++++++++++++-- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/source/handbook/engineering/issues/issue-triage-policies.html.md b/source/handbook/engineering/issues/issue-triage-policies.html.md index 6ccfc25fef4..0e27c70b5a8 100644 --- a/source/handbook/engineering/issues/issue-triage-policies.html.md +++ b/source/handbook/engineering/issues/issue-triage-policies.html.md @@ -3,9 +3,37 @@ layout: markdown_page title: Issue Triage Policies --- -GitLab believes in [Open Development](open-development), and we encourage the community to file issues and open merge requests for our projects on [GitLab.com](https://gitlab.com/groups/gitlab-org). Their contributions are valuable, and we should aim to triage new issues as promptly as we can in recognition of this. +GitLab believes in [Open Development][open-development], and we encourage the community to file issues and open merge requests for our projects on [GitLab.com](https://gitlab.com/groups/gitlab-org). Their contributions are valuable, and we should handle them as effectively as possible. A central part of this is triage - the process of categorisation according to type and severity. -Triage is something any engineer at GitLab can do. Keeping the number of untriaged issues low is essential for maintainability, and is our collective responsibility. Consider triaging a few [issues](untriaged-issues-query) around your other responsibilities, or scheduling some time for it on a regular basis. +Any GitLab team member can triage issues. Keeping the number of untriaged issues low is essential for maintainability, and is our collective responsibility. Consider triaging a few issues around your other responsibilities, or scheduling some time for it on a regular basis. + +## Triaging issues + +Initial triage involves (at a minimum) labelling an issue appropriately, so untriaged issues can be discovered by searching for issues without any labels. Follow one of these links: + +* [GitLab CE][ce-issues-query] +* [GitLab EE][ee-issues-query] +* [GitLab Omnibus][omnibus-issues-query] + +You may also find issues that need triaging in the [GitLab Support Forum][support-issues-query]. + +Pick an issue, with preference given to the oldest in the list, and evaluate it with a critical eye, bearing the [policies](#policies) below in mind. Some questions to ask yourself: + +* Do you understand what the issue is describing? +* What labels apply? Particularly consider [team, subject and type](/handbook/engineering/workflow/#labelling-issues) labels +* How critical does it seem? Would the `security` label be appropriate? + +Apply each label that seems appropriate. Issues with a security impact should be treated specially - see the [security disclosure process](/handbook/support/#security-disclosures-a-namesecuritya). + +If the issue seems unclear - you aren't sure which labels to apply - ask the requestor to clarify matters for you. Keep our [user communication guidelines](handbook/#user-communication-guidelines) in mind at all times, and commit to keeping up the conversation until you have enough information to complete triage. + +Check for duplicates! Searching for some keywords in the issue should give you a short list of possibilities to scan through. Check both open and closed issues, as it may be a duplicate of a solved problem. + +Consider whether the issue is still valid. Especially for older issues, a `bug` may have been fixed since it was reported, or a `feature request` may have already been implemented. + +If the issue meets the requirements, it may be appropriate to make a [scheduling request](/handbook/engineering/workflow/#scheduling-issues) - use your judgement! + +You're done! The issue has all appropriate labels, and may now be in the backlog, closed, awaiting scheduling, or awaiting feedback from the requestor. Pick another, if you've got the time. ## Policies @@ -62,7 +90,10 @@ The following projects, resources, and blog posts were very helpful in crafting - [The Art of Closing][art-of-closing] [open-development]: https://about.gitlab.com/2015/12/16/improving-open-development-for-everyone/ -[untriaged-issues-query]: https://gitlab.com/gitlab-org/gitlab-ce/issues?scope=all&sort=updated_asc&state=opened&assignee_id=0&milestone_title=No+Milestone&label_name%5B%5D=No+Label&weight=No+Weight +[ce-issues-query]: https://gitlab.com/gitlab-org/gitlab-ce/issues?scope=all&sort=updated_asc&state=opened&assignee_id=0&milestone_title=No+Milestone&label_name%5B%5D=No+Label&weight=No+Weight +[ee-issues-query]: https://gitlab.com/gitlab-org/gitlab-ee/issues?scope=all&sort=updated_asc&state=opened&assignee_id=0&milestone_title=No+Milestone&label_name%5B%5D=No+Label&weight=No+Weight +[omnibus-issues-query]: https://gitlab.com/gitlab-org/omnibus-gitlab/issues?scope=all&sort=updated_asc&state=opened&assignee_id=0&milestone_title=No+Milestone&label_name%5B%5D=No+Label&weight=No+Weight +[support-issues-query]: https://gitlab.com/gitlab-com/support-forum/issues?scope=all&sort=updated_asc&state=opened&assignee_id=0&milestone_title=No+Milestone&label_name%5B%5D=No+Label&weight=No+Weight [17693]: https://gitlab.com/gitlab-org/gitlab-ce/issues/17693 [code-triage]: https://www.codetriage.com/ [open-source-gardener]: http://words.steveklabnik.com/how-to-be-an-open-source-gardener -- GitLab