Issues guidelines - arangace/CreamCat GitHub Wiki
Issue
- A title and description to describe what the issue is all about.
- Comments allow anyone with access to the repository to provide feedback.
Milestones
Groups of issues that correspond to a project, feature, or time period. Some examples:
- Beta Launch — File bugs that you need to fix before you can launch the beta of your project. It’s a great way to make sure you aren’t missing anything.
- October Sprint — File issues that you’d like to work on in October. A great way to focus your efforts when there’s a lot to do.
- Redesign — File issues related to redesigning your project. A great way to collect ideas on what to work on.
Labels
For organizing different types of issues. Issues can have as many labels as necessary, and be filter by one or many labels at once.
Assignees
Each issue can have an assignee — one person that’s responsible for moving the issue forward. Assignees are selected the same way milestones are, through the grey bar at the top of the issue.
@mentions
- @mentions are the way to reference other GitHub users inside of GitHub Issues
- Include the @username inside of the description or any comment of the issue to send a notification to another GitHub user
/cccan be used to include people in issues:
It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?
/cc @kneath @jresig
References
- Reference issues by typing in a hashtag plus the issue number to relate one issue to another (e.g.,
#42) - Include the repository before the name like to reference an issue from another repository(e.g.
kneath/example-project#42) - Reference issues directly from commits.
- Include the issue number inside of the commit message
- Prefacing the commit with “Fixes”, “Fixed”, “Fix”, “Closes”, “Closed”, or “Close”
- Automatically close the issue when the commit is merged into main