Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding instructions for issue triaging #39

Merged
merged 5 commits into from
Apr 18, 2020
Merged

Adding instructions for issue triaging #39

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2898681
Adding instructions for issue triaging
sffc Apr 17, 2020
611f4c3
core -> core feature
sffc Apr 17, 2020
61da620
Fix search query for "core feature"
sffc Apr 17, 2020
6d7ca6a
Add more information about open versus backlog.
sffc Apr 17, 2020
729164e
Fix typo
sffc Apr 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions docs/triaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Issue Triaging
==============

OmnICU uses GitHub for tracking feature requests and work items.

- All issues should have a type label.
- [Query: issues needing a type](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+-label%3Abug+-label%3Acore+-label%3Adocumentation+-label%3Aenhancement+-label%3Aquestion+-label%3Ainvalid)
- All *open* or *backlog* issues should have and assignee or **help wanted** label.
- [Query: open or backlog issues needing assignee or help wanted](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aopen+-label%3A%22help+wanted%22+no%3Aassignee+)
- All *closed* issues should have a resolution, linked pull request, or the **question** type.
- [Query: closed issues needing resolution or linked PR](https://github.com/unicode-org/omnicu/issues?q=is%3Aissue+is%3Aclosed+-linked%3Apr+-label%3Aquestion+-label%3Abacklog)

## Fields

### Type

The following labels are types; every issue should have one:

- **bug** = a defect in existing code.
- **core** = a high-priority improvement or new feature.
nciric marked this conversation as resolved.
Show resolved Hide resolved
- **documentation** = relates to documentation, including user guide, architecture design, team processes, and API docs.
- **enhancement** = a lower-priority improvement or new feature.
- **question** = an issue that can be addressed in the discussion thread without checking in any code or documentation.
- **invalid** = spam, etc.

### Assignee

The assignee is the user who is the "champion" for the issue: tracking its progress, obtaining the necessary approvals, and so forth. The assignee is often the same as the reporter. The assignee is not necesarilly the same as the user who is writing the necessary code fixes.

An issue may have the **help wanted** label if there is no assignee.

### Resolution

All *closed* issues should have either (1) the "question" type, (2) a linked pull request, or (3) one of the following labels:

- **backlog** = the issue is not fixed, but it could be revisited in the future.
- **duplicate** = the issue is a duplicate of some other issue.
- **needs more info** = the issue might be valid, but the subcommittee either does not understand the issue or was unable to reproduce it. The reporter should provide more information.
- **obsolete** = the issue is superseded or no longer relevant.
- **wontfix** = the issue is valid, but the subcommittee has concluded that the library is working as intended.

### Optional Labels

The following labels are optional and can be applied to an issue if appropriate:

- **good first issue** = this would be good for a new contributor.