-
Notifications
You must be signed in to change notification settings - Fork 0
Guidelines on how to post an issue to this project's Github issue queue
Chris Wells edited this page Aug 18, 2015
·
2 revisions
I've added in the details I think a good Github issue should feature but please hack away at this page if you think differently:
| Line item | Description of content you should add to line item |
|---|---|
| Issue title | Add a brief, abbreviated, but descriptive title explaining what action needs to take place to remove the issue |
| Logged in as | Add your machine-readable user name you were logged in as when the issue arose |
| Dev instance | Describe where you were on the site, accompanied by a URL to where you first noticed the issue |
| Issue description | Describe what you were doing that led to the issue and what happened |
| Solution | Describe how you would like the issue to be resolved |
| Screenshot(s) | Include screenshots using OSX: Command+Shift+4, Windows: open Snipping Tool and capture a section of screen to the clipboard then paste into issue |
| /CC @pmackay | Copy in other users with /CC @username to add other relevant people to the issue who aren't the key assignment |
In addition to the basics, it's worth checking you've added in the right metadata to an issue:
- Duplicate issues: Check this issue doesn't already exist – if you find an issue which is a duplicate of an existing one, add a duplicate label and close it, after notifying the creator that they've made a duplicate.
- Labels: Check you've added correct labels
- Assignment: Assign the right team member
- Milestone: Check you've set the issue to be scheduled for the right project milestone
- Link to other issues: Add a reference to any other relevant current issues or Trello board items
- Save this into a text snippet which you can automatically paste into every new Github issue you create
When adding an issue which is not an error report but a task request for a known task, add the following snippet into the Description field of your issue to ensure you cover the required information:
- URL of page relating to task
- User role (if relevant)
- Relevant Views
- Relevant Fields
- @djwesto - Numbered steps needed to complete the task
- @pmackay - prepended by username of team member responsible
- As a numbered list of