Skip to content

Up For Grabs guidance template

ArtOfCode edited this page Oct 3, 2019 · 2 revisions

Contributor Guidance

Summary

Difficulty:

This Summary section should contain an overview of what the issue involves. Describe basically what it is - essentially repeating the original issue comment. You may also want to briefly mention some rationale for the issue or potential trip points a contributor might encounter.

Guidance

This is a more detailed run-down of what the fix might look like. Include details like relevant files (and line numbers if that's useful), method and variable names, with links where relevant. Suggest how a contributor might go about fixing the issue, but try not to dictate - you're walking a line here between leaving people in the dark and doing all the work for them. Finish off by asking them to open a pull request when they're done and we'll review it together.

How to get help

For additional support in completing this issue, either:

  • comment on this thread
  • if you have a Stack Overflow account, drop into our chatroom (you'll need 20 reputation - if you don't have that, let us know your username or ID here and someone will grant access manually)