Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 3.13 KB

Good-GitHub-Issues.md

File metadata and controls

41 lines (25 loc) · 3.13 KB

Writing Good GitHub Issues

GitHub issues are where dicussions about open source projects happen. Getting good at writing GitHub issues will get you more help building your projects as well as improve your practice of building open source.

Good issues will get you more help by making it easy for outside contributors to understand your project and help you out.

Good issues are also professional development. Many technology and government jobs have a remote first work style where all conversations happen online in tools like GitHub issues. Having a public trail of well formed issues can help get you paid. 💰💰💰

Example

A favorite example.

It clearly describes what is going on, includes relevant user research, points to the necessary files, and has a checklist of actions to take. The conversation is pretty good too, with lots of code samples and references to the issue from commits.

Sections

Common sections to include in your issue. Don't go overboard, just use what you need.

#### Description
#### Screenshots
#### To Reproduce
#### Files
#### Tasks

Template

To easily start a new issue with all of these sections, use this template

Labels

GitHub labels are a quick way to categorize your issues. bug and enhancement are really useful when trying to organize your sprints. We'll often add new labels such as python or design if want to make it clear what skills are needed to help with that issue.

Help Wanted

Code for America has built some tools that make the help wanted label special. If you label your issue with help wanted we'll promote it widely using the Civic Issue Finder and other tools. These tools get lots of attention, so use them to get helpful PRs from strangers.

Milestones

Milestones are useful way to group issues together with a due date. Here is an example.

GitHub has a useful guide that goes even deeper.