Good First Issues
Dale Wijnand edited this page Jun 12, 2018
·
11 revisions
To label an issue as a good first issue it should:
- follow the issue template
- be an accepted feature/enhancement request or a confirmed (ideally reproducible) bug
- be approachable by a first time contributor, a good measure is it should takes a maintainer 20 minutes to resolve (which translates to 1-2 hours for a newcomer)
A good first issue should include mentoring instructions that layout the steps to take to resolve an issue.
Steps:
- Links: Link to the relevant code, PRs, issue threads, docs, etc
- Solution: Add comments/hints on how to resolve the issue (and non-solutions)
- Testing: Try and give testing tips, ideally link to prior art
- Motivation (optional): Explain the change's relevance or purpose
- Background (optional): Explain the code's behaviour, structure, or context
It's common that it takes longer to write mentoring instructions than to fix it yourself (as an experienced maintainer) - this is an investment in making sbt easier to contribute to and a potential long-term contributor, possibly maintainer.
I suggest saving the following markdown template as a GitHub "Saved Reply" so you can append it to an issue's original description:
---
# Mentoring Instructions
## Links
## Solution
## Testing
## Motivation
## Background