Specify the How-to is for maintainers

from feedback from Toni
Dale Wijnand 2018-04-11 16:32:09 +01:00
parent 2620e08d2d
commit 656aa3f7c3
No known key found for this signature in database
GPG Key ID: 4F256E3D151DF5EF
1 changed files with 3 additions and 2 deletions

@ -15,9 +15,10 @@ To label an issue as a [good first issue][] is it must be:
* approachable by a first time contributor (a good entry point)
* should take an experienced maintainer 15-20 minutes to solve, and therefore a newcomer about 1-2 hours
## How To
## How-to write a good first issue (as a maintainer)
To convert an issue (e.g a [help wanted][] issue) so that it's ready for a new contributor do the following:
As a maintainer these are the steps that should be taken to convert an issue (e.g a [help wanted][] issue) so
that it's ready for a new contributor do the following:
1. get familiar with the issue, and some of the associated code/tests/docs
2. make sure the [issue template](https://raw.githubusercontent.com/sbt/sbt/1.x/ISSUE_TEMPLATE.md) is followed (steps/problem/explanation/notes) so it's clear what is wrong and/or