github-issues-howto.md

GitHub Issues How-To Manual

Issue labels

There are a few pre-defined label families to organize/search issues.

• type : issue type
  • type:bug is attached to bug reports
  • type:enhancement is attached to enhancement requests or suggestions
  • type:test is attached to test improvements or failure reports
  • type:task is attached to general tasks
  • type:documentation is attached to tasks relate to documentation
• fix-version : the versions in which a bug or enhancement is planned to be released
  • this may be used for release planning
  • (example) fix-version:10.0.0
• affects-version : the versions in which a bug was found
  • this may be used with type:bug
  • (example) affects-version:9.1.0
• module : Lucene module
  • (example) module:core/index, module:analysis
• tool : tooling
  • (example) tool:build, tool:release-wizard

A type label is automatically attached to an issue by the issue template that the reporter selected. Other labels such as fix-version may be manually added by committers.

If necessary, uncategorized labels may also be used.

• good first issue
• discuss
• duplicate
• website

Committers can add/edit labels manually or programmatically using Labels API.

Issue templates

Each issue template (web form) is associated with one type label. You should add an issue template when adding a new type label and vice versa.

• Bug Report is associated with type:bug label
• Enhancement Request/Suggestion is associated with type:enhancement label
• Test Improvement / Failure Report is associated with type:test label
• Task is associated with type:task label
• Documentation is associated with type:documentation label

Issue templates are written in YAML format and committed in .github/ISSUE_TEMPLATE. See GitHub documentation for details.