-
Notifications
You must be signed in to change notification settings - Fork 51
Simple: Issues
Issues is GitHub's great&simple bugtracker. Open Issue list from right panel on main repo page.
It's simple, yet can be great tool.
Always mention issue in commit. ie. You've worked on some Guardsmen stats, according to Issue #102 you saw on Issue list.
To simply mention the issue, enter Guardsmen profile update - #102 and it's linked!
If you feel like the issue is fixed/closed, you can close it on Issue's page. There's a button on the bottom.
However if after edit you think it's all to be done for that issue, you can close it directly by mentioning it after fix/fixes/close/closes/see more keywords, ie. Ork profile update, closes #93. Cool, right?
You should use labels to tag issues as bugs or enhancements, or if Issue is a topic for discussion, tag it "question". If you see something that was solved, but a new issue was created, tag it as duplicate, and after commenting with a link to proper issue, close it.
Milestones on the other hand group Issues together. We still discuss how to use them. One way we see it is to create Milestones for each Rulebook generation, for each file created. So Milestones would be titled like Skaven 8th Ed and closed after edition change. But that will depend on actual repo. Check that repo's wiki for actual guidelines.
Next up: General Catalogue writing guidelines