summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-01-03 16:03:30 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2015-01-03 16:03:30 -0800
commit4866c905b0dbca5338c04b9cdcad20bc5846c710 (patch)
treeb46e65cb50188d80a8a6f678fd6ea66cdff4eebf
parenta6d469afdccd84a91c4bfb297ef1eb6d04cc4fa3 (diff)
Minor reformatting of CONTRIBUTING.md.
-rw-r--r--CONTRIBUTING.md55
1 files changed, 27 insertions, 28 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cf6ea7bef..168392bc0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -28,29 +28,28 @@ try to whittle it down to the minimum necessary to illustrate the problem.
Fixing bugs from the issue tracker
----------------------------------
-Almost all the bugs on the issue tracker have one or more associated tags. These
-are used to indicate the *difficulty* and *nature* of a bug. There is not yet a
-way to indicate priority. An up to date summary of issues can be found
-[here](https://github.com/jgm/pandoc/labels)
-
-* [Enhancement] -- A feature which would be desirable.
-* [Bug] -- A problem which needs to be fixed.
-
-* [Minor] -- The fix should only be a couple of lines.
-* [Major] -- The fix might require structural changes or in depth knowledge of
+Almost all the bugs on the issue tracker have one or more associated
+tags. These are used to indicate the *difficulty* and *nature* of a
+bug. There is not yet a way to indicate priority. An up to date
+summary of issues can be found [here](https://github.com/jgm/pandoc/labels).
+
+* [enhancement] -- A feature which would be desirable. We recommend
+ you discuss any proposed enhancement on pandoc-discuss before
+ writing code.
+* [bug] -- A problem which needs to be fixed.
+* [minor] -- The fix should only be a couple of lines.
+* [major] -- The fix might require structural changes or in depth knowledge of
the code base.
-* [Reader] -- A request to add a new input format.
-* [Writer] -- A request to add a new output format.
+* [reader] -- A request to add a new input format.
+* [writer] -- A request to add a new output format.
* [docs] -- A discrepency or ambiguity in the documentation.
-
* [inprogress] -- Someone is actively working on or planning to work on the
-ticket.
-* [More discussion needed] -- It is unclear what the correct approach to solving
-the ticket is. Before starting on tickets such as this it would be advisable to
-post on the ticket.
-* [More info needed] -- We require more information from a user before we can
-classify a report properly.
-
+ ticket.
+* [more discussion needed] -- It is unclear what the correct approach
+ to solving the ticket is. Before starting on tickets such as this it
+ would be advisable to post on the ticket.
+* [more info needed] -- We require more information from a user before
+ we can classify a report properly.
Have an idea for a new feature?
-------------------------------
@@ -209,13 +208,13 @@ The library is structured as follows:
[EditorConfig]: http://editorconfig.org/
[Haskell platform]: http://www.haskell.org/platform/
[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
-[Enhancement]: https://github.com/jgm/pandoc/labels/enhancement
-[Bug]: https://github.com/jgm/pandoc/labels/bug
-[Minor]: https://github.com/jgm/pandoc/labels/Minor
-[Major]: https://github.com/jgm/pandoc/labels/Major
-[Reader]: https://github.com/jgm/pandoc/labels/Reader
-[Writer]: https://github.com/jgm/pandoc/labels/Writer
+[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
+[bug]: https://github.com/jgm/pandoc/labels/bug
+[minor]: https://github.com/jgm/pandoc/labels/Minor
+[major]: https://github.com/jgm/pandoc/labels/Major
+[reader]: https://github.com/jgm/pandoc/labels/Reader
+[writer]: https://github.com/jgm/pandoc/labels/Writer
[docs]: https://github.com/jgm/pandoc/labels/docs
[inprogress]: https://github.com/jgm/pandoc/labels/inprogress
-[More discussion needed]: https://github.com/jgm/pandoc/labels/More%20discussion%20needed
-[More info needed]: https://github.com/jgm/pandoc/labels/More%20info%20needed
+[more discussion needed]: https://github.com/jgm/pandoc/labels/More%20discussion%20needed
+[more info needed]: https://github.com/jgm/pandoc/labels/More%20info%20needed