apache/lucene-jira-archive

Document issue label / template management policy

Closed this issue · 3 comments

mocobeta commented
  • Explicitly define label families (e.g., type:xxx, fixVersion:x.x.x)
  • Clarify the mapping between labels and issue templates
  • Write documentation and make it accessible to developers (e.g., place it under dev-docs in the lucene repo)
mocobeta commented

Pre-set labels should be fixed before migration since we need to attach them to migrated issues in the import scripts.
Label texts can be changed afterward, but they'd have to be manually changed (we are not allowed to call GitHub API on ourselves) and it'd be bothersome and error-prone.

I'd propose four label families:

  • type : Jira's "Issue Type"
    • type:bug for a bug report. The corresponding Jira issue type is Bug.
    • type:enhancement for an enhancement. The corresponding Jira issue types are New Feature, Improvement, and Wish.
    • type:task for a task. The corresponding Jira issue type is Task.
    • type:test for test-related issues. The corresponding Jira issue type is Test
  • fixVersion : Jira's "Fix Version(s)"
    • e.g.: fixVersion:9.2.0
  • affectsVersion: Jira's "Affects Version(s)"
    • e.g.: affectsVersion:9.0.0
  • component : Jira's "Component(s)"
    • e.g.: component:module/core/index, component:module/analysis
  • uncategorized (Resolution, etc.)
    • duplicate, invalid, wontfix, discuss, documentation
mocobeta commented

Label texts can be changed afterward, but they'd have to be manually changed (we are not allowed to call GitHub API on ourselves) and it'd be bothersome and error-prone.

It's not correct - I tested Update a label API in this repo and the request was accepted. We'll be able to update label texts ourselves with some scripts if it's needed.

I once posted a proposal and haven't seen any comments on that so far, then I'd run the migration script as above without making extra posts in the dev list. Will provide information about the API if there are requests for refinements after the migration is finished.

mocobeta commented

Issue templates proposal:

  • Bug Report - this is associated with type:bug label
  • Enhancement Request - this is associated with type:enhancement label
  • Test Failure Report - this is associated with type:testFailure label
  • Task - this is associated with type:task label
  • Documentation - this is associated with type:documentation label
  • Question - this creates no issues; is used to guide users to mailing lists markdown-only template is not allowed.