Skip to content

Instantly share code, notes, and snippets.

@stevepeak
Last active October 25, 2018 03:26
Show Gist options
  • Save stevepeak/9f5d9f17677f681299b9 to your computer and use it in GitHub Desktop.
Save stevepeak/9f5d9f17677f681299b9 to your computer and use it in GitHub Desktop.
How to use Github Issue

Milestone Policy

Name must start with a expected version tag ex: v1.4.6. An optional small description is allowed ex: v1.4.6 Custom Title the only these characters are allowed in the title [A-Za-z\d\s\-\:]

Open Milestone

  • tagged version is not deployed to customer
  • pre-release may be available

Open and Complete

  • available in Pre Release for further testing
  • not deployed to customers

Close and Complete

  • deployed (or will deploy) to customers
  • marked as a Latest Release

Issue Policy

The issue title should be as short as possible at describing the 10k foot view and contain only these characters [A-Za-z\d\s\-\:].

Open Issues

  • need programming
  • being programmed
  • having discussions on

Closed Issues

  • have been programmed
  • passed locally testing and CI testing
  • w/ label duplicate, merged, invalid, wont fix, etc.

Reopening Policy

  1. Do not reopen issues if its just a question
    • a notification still gets sent to the subcribers, even when closed
  2. Reopen the closed issue if bug is proven to persist
    • evidence must be provided, not just a message "Not working"
  3. Create new issue (referenced to closed issue) is a new related issue is found
    • but is significant enough that it deserves its own Issue
    • reference at top of issue via this markdown > new issues related to #54

Labels

  • wip a programmer is actively working on this issue
  • needs testing (typically on closed issues) this is needing further testing before deployment
  • feature when there new concepts presented
    • required a detailed list of objectives (using - [ ] markdown) describing what is needed to be done in the feature
  • enhancement when an existing feature needs enhancement
    • never feature and enhancement
  • question when the issue is more of a missunderstanding or a question
  • bug when a feature is found to have a bug
    • required provide step-by-step methods to reproduce. (no one liners here)
  • wontfix
    • when closed: no code should be commited
  • duplicate another issue exists already with the presented concept or merged into another ticket
    • optional providing referenced ticket

References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment