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.

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

Recommend a generic set of labels to add to a project's issue tracker #7

Open
mojavelinux opened this issue Oct 8, 2013 · 0 comments

Comments

@mojavelinux
Copy link
Member

Recommend a generic, but useful, set of labels that should be added to a project's issue tracker.

Refer to the asciidoctor, asciidoctor.org and asciidoctor-documentation issue trackers for some ideas.

When the issue tracker lacks appropriate labels, it makes it more difficult for a user to enter a good "bug" report. The labels act as a guide to focus the user on the type of information that's needed.

The labels also help the maintainer keep the issues organized and scheduled. Without a good set of labels, the issue tracker ends up being a dumping ground of ideas and problems all mixed together.

That's my experience, at least.

I also think there should be several generic milestones that complement the labels. One of the most important is "support". These are issues that don't require changes to the software, and thus aren't tied to a release, but do needed to be answered and eventually closed like other issues. Other generic milestones may include "future", "design", "on hold" and so forth.

One note about the "design" milestone. I'm still debating whether this milestone can be used to group issues as a substitute for a mailinglist. It can quickly get abused for large, open ended questions or pie in the sky feature requests. On a mailinglist these naturally fall by the wayside, but in an issue tracker they earn a certain permanence. Perhaps we can just mention that this may happen and to be careful not to let it distract the focus of keeping the issue tracker groomed and addressing the more pressing issues.

@mojavelinux mojavelinux transferred this issue from asciidoctor/asciidoctor-documentation-planning Feb 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant