Skip to content

How to use GitHub issues?

Thomas Götschi edited this page Feb 1, 2018 · 6 revisions

a little bit of guidance on the use of GitHub issues

  • issues can be anything from general discussions to very specific tasks, questions, problems
  • try not to mix unrelated stuff, avoid laundry lists. - instead, start new issues, and link them
  • you can refer to other issues using #issuenumber as a link
  • you can tag collaboraters with @username
  • you can use various markdown format features. Checklists in particular can be helpful
  • you can assign issues and label them. Make generous use of labels!
  • you can link to wiki pages, or anything else
  • under settings you can set up how you want to be notified about changes to issues (typically set to alerts on issues that you are tagged in)

Clone this wiki locally