11 Good First Issues

Dale Wijnand edited this page 2018-06-12 14:15:34 +01:00

Table of Contents

• Good First Issues
• Criteria
• Mentoring Instructions
• Markdown template

Good First Issues

Criteria

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)

Mentoring Instructions

A good first issue should include mentoring instructions that layout the steps to take to resolve an issue.

Steps:

1. Links: Link to the relevant code, PRs, issue threads, docs, etc
2. Solution: Add comments/hints on how to resolve the issue (and non-solutions)
3. Testing: Try and give testing tips, ideally link to prior art
4. Motivation (optional): Explain the change's relevance or purpose
5. 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.

Markdown template

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