What feedback should be here vs. on GitHub?


#1

You might wonder – which place should I post feedback regarding the software to?

If you have a specific, straightforward bug or fix, things that are not controversial or subject to interpretation and opinion, open as a GitHub issue:

  • you misspelled this word
  • this code has a bug in the following conditions (repro steps…)
  • performance can improve 10% with the following change (benchmark…)

If you have an open ended issue that will require extended discussion and deliberation to arrive at a solution or conclusion, do it here:

  • traditional 4 space indent code blocks should be replaced entirely by fenced code blocks
  • the following additional test cases are needed (here is why)
  • how do we resolve / clarify this ambiguity in the spec

Those rules are largely inspired from:
http://talk.commonmark.org/t/what-feedback-should-be-here-vs-on-github/25


#3