WIP: Github issues for non developers

Using Github Issues

What is Github Issues?

Github Issues is the project management and issue tracking system used by the development team. It allows us to create and track issues in the same place where we're keeping our code!

How can a non-developer use Github Issues?

If you're not a developer, you can still use Github issues! You can create and add comments to issues, follow their completion progress, and provide feedback on our code.

Prerequisites

• Create an account on Github.com
• Navigate to the covidcanidoit github repository

Searching for issues

Search using search bar

1. Navigate to the issues tab
2. The search bar will be prepopulated with is:issue and is:open
   • is:issue means that pull requests (which are how we get feedback on our code) will be excluded
   • is:open means that issues that are closed (either because they're complete, or they will not be completed) will be excluded
3. Use the search bar to search for your issue
   • If you do not see your issue, you can try clicking the closed button to see if the issue may be closed.

Search using labels

Search using milestones

Milestones are groups of tickets associated with a project, feature, or a time period.

Creating a new issue

1. Navigate to the issues tab
2. Click the new issue button to the right of the search bar
3. Add an title and description for your issue. More information is always better!

Adding labels

Labels are used to categorize issues by type. Here are a few examples of when to use common labels:

• bug should be used if there is something wrong with the website
• enhancement should be used if this is an improvement or a new feature of the website
• idea should be used if it has not yet been decided that we will move forward with a new feature
• usability should be used if the issue prevents a user from using the website
• visual should be used if an issue is mainly visual

Once you're done with your issue, you can submit it! By default, you'll get a notification every time there's a new update to your issue

See Also

Github Guides: Issues
Github Docs: About Issues

Feel free to reach out to the development team with any questions or issues!