What makes a good issue?

Since issues serve as the project's to-do list, writing good, helpful issues is important. We use issue templates to support writing good issues, but we also list some features of good issues below to guide you in writing your best issues.

Good issues include the following:

• A title that is informative about the contents of the issue at a glance
• A relatively small and focused scope, such that the pull request that closes them is appropriate in scope
• Ideas about how to accomplish a segment of work
• Enough context so that:
  • Someone other than the issue author can accomplish the work
  • Pull request reviewers are set up for success
• The requirements for satisfying or closing the issue (when known)