git.iko.soy/typeable/pandoc
on master help sign in
Updated CONTRIBUTING.md with information about issue tags
47b8256Matthew Pickering
CONTRIBUTING.md+37
@@ -25,6 +25,33 @@ including
25A small test case (just a few lines) is ideal. If your input is large,
25A small test case (just a few lines) is ideal. If your input is large,
26try to whittle it down to the minimum necessary to illustrate the problem.
26try to whittle it down to the minimum necessary to illustrate the problem.
27
27
28+Fixing bugs from the issue tracker
29+----------------------------------
30+
31+Almost all the bugs on the issue tracker have one or more associated tags. These
32+are used to indicate the *difficulty* and *nature* of a bug. There is not yet a
33+way to indicate priority. An up to date summary of issues can be found
34+[here](https://github.com/jgm/pandoc/labels)
35+
36+* [Enhancement] -- A feature which would be desirable.
37+* [Bug] -- A problem which needs to be fixed.
38+
39+* [Minor] -- The fix should only be a couple of lines.
40+* [Major] -- The fix might require structural changes or in depth knowledge of
41+the code base.
42+* [Reader] -- A request to add a new input format.
43+* [Writer] -- A request to add a new output format.
44+* [docs] -- A discrepency or ambiguity in the documentation.
45+
46+* [inprogress] -- Someone is actively working on or planning to work on the
47+ticket.
48+* [More discussion needed] -- It is unclear what the correct approach to solving
49+the ticket is. Before starting on tickets such as this it would be advisable to
50+post on the ticket.
51+* [More info needed] -- We require more information from a user before we can
52+classify a report properly.
53+
54+
28Have an idea for a new feature?
55Have an idea for a new feature?
29-------------------------------
56-------------------------------
30
57
@@ -182,3 +209,13 @@ The library is structured as follows:
182[EditorConfig]: http://editorconfig.org/
209[EditorConfig]: http://editorconfig.org/
183[Haskell platform]: http://www.haskell.org/platform/
210[Haskell platform]: http://www.haskell.org/platform/
184[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
211[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
212+[Enhancement]: https://github.com/jgm/pandoc/labels/enhancement
213+[Bug]: https://github.com/jgm/pandoc/labels/bug
214+[Minor]: https://github.com/jgm/pandoc/labels/Minor
215+[Major]: https://github.com/jgm/pandoc/labels/Major
216+[Reader]: https://github.com/jgm/pandoc/labels/Reader
217+[Writer]: https://github.com/jgm/pandoc/labels/Writer
218+[docs]: https://github.com/jgm/pandoc/labels/docs
219+[inprogress]: https://github.com/jgm/pandoc/labels/inprogress
220+[More discussion needed]: https://github.com/jgm/pandoc/labels/More%20discussion%20needed
221+[More info needed]: https://github.com/jgm/pandoc/labels/More%20info%20needed