luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Drop "Help" from Mentoring Instructions in Good First Issues

Dale Wijnand 2018-05-14 18:01:20 +02:00
parent 0060c301ca
commit 78d6d0861d
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
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