From 656aa3f7c3ba086b84be7716a9a439c5646565c3 Mon Sep 17 00:00:00 2001 From: Dale Wijnand Date: Wed, 11 Apr 2018 16:32:09 +0100 Subject: [PATCH] Specify the How-to is for maintainers from feedback from Toni --- Good-First-Issues.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Good-First-Issues.md b/Good-First-Issues.md index e7602ab..7f5c5dd 100644 --- a/Good-First-Issues.md +++ b/Good-First-Issues.md @@ -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