git.iko.soy/typeable/pandoc
on master help sign in
CONTRIBUTING.md: minor change in wording and punctuation (#3252)

- em-dash should be used here, not en-dash (which is for, e.g., ranges). - unicode em-dash is used because GitHub don’t do SmartyPants on dashes.

commit07b306040364f71d820958f9c47216f99c483680 authorickc <ickc@users.noreply.github.com> dateThu 24 Nov 2016, 01:02 (10 years ago) parent03788eb
1 file changed+13−13
CONTRIBUTING.md+13−13
CONTRIBUTING.md+13−13
@@ -14,16 +14,16 @@ for anything relevant.
1414Make sure you can reproduce the bug with the latest released version of pandoc
1515(or, even better, the development version).
1616
17−Your report should give detailed instructions for how to reproduce the problem,
18−including
17+Your report should give detailed, *reproducible* instructions, including
1918
19+ * the pandoc version (check using `pandoc -v`)
2020 * the exact command line used
2121 * the exact input used
2222 * the output received
2323 * the output you expected instead
2424
2525A small test case (just a few lines) is ideal. If your input is large,
26−try to whittle it down to the minimum necessary to illustrate the problem.
26+try to whittle it down to a *minimum working example*.
2727
2828Out of scope?
2929-------------
@@ -59,22 +59,22 @@ tags. These are used to indicate the *difficulty* and *nature* of a
5959bug. There is not yet a way to indicate priority. An up to date
6060summary of issues can be found [here](https://github.com/jgm/pandoc/labels).
6161
62−* [enhancement] -- A feature which would be desirable. We recommend
62+* [enhancement] — A feature which would be desirable. We recommend
6363 you discuss any proposed enhancement on pandoc-discuss before
6464 writing code.
65−* [bug] -- A problem which needs to be fixed.
66−* [minor] -- The fix should only be a couple of lines.
67−* [major] -- The fix might require structural changes or in depth knowledge of
65+* [bug] — A problem which needs to be fixed.
66+* [minor] — The fix should only be a couple of lines.
67+* [major] — The fix might require structural changes or in depth knowledge of
6868the code base.
69−* [reader] -- A request to add a new input format.
70−* [writer] -- A request to add a new output format.
71−* [docs] -- A discrepency or ambiguity in the documentation.
72−* [inprogress] -- Someone is actively working on or planning to work on the
69+* [reader] — A request to add a new input format.
70+* [writer] — A request to add a new output format.
71+* [docs] — A discrepency or ambiguity in the documentation.
72+* [inprogress] — Someone is actively working on or planning to work on the
7373 ticket.
74−* [more discussion needed] -- It is unclear what the correct approach
74+* [more discussion needed] — It is unclear what the correct approach
7575 to solving the ticket is. Before starting on tickets such as this it
7676 would be advisable to post on the ticket.
77−* [more info needed] -- We require more information from a user before
77+* [more info needed] — We require more information from a user before
7878 we can classify a report properly.
7979
8080Have an idea for a new feature?