From 78d6d0861d6dbc556690f3f48697d00ac8bddaa2 Mon Sep 17 00:00:00 2001 From: Dale Wijnand <344610+dwijnand@users.noreply.github.com> Date: Mon, 14 May 2018 18:01:20 +0200 Subject: [PATCH] Drop "Help" from Mentoring Instructions in Good First Issues --- Good-First-Issues.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/Good-First-Issues.md b/Good-First-Issues.md index 5d5fbb3..d682264 100644 --- a/Good-First-Issues.md +++ b/Good-First-Issues.md @@ -23,11 +23,10 @@ A [good first issue][] should include mentoring instructions that layout the ste Steps: 1. **Links**: Link to the relevant code, PRs, issue threads, docs, etc -2. **Solution**: Add comments/hints on how to resolve the issue (call out "non-solutions" if relevant) +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. **Help**: Explain how to ask for help (e.g ping @eed3si9n in the issue and/or on [sbt/sbt-contrib][]) -5. **Motivation** (optional): Explain the change's relevance or purpose (to motivate the contribution) -6. **Background** (optional): Explain the code's behaviour, structure, or context +4. **Motivation** (optional): Explain the change's relevance or purpose (to motivate the contribution) +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 investiment in [making sbt easier to contribute to][] and a potential long-term