@@ -55,28 +55,34 @@ Fixing bugs from the issue tracker
55----------------------------------
55----------------------------------
57Almost all the bugs on the issue tracker have one or more associated
57Almost all the bugs on the issue tracker have one or more associated
58−tags. These are used to indicate the *difficulty* and *nature* of a
58+tags. These are used to indicate the *complexity* and *nature* of a
59bug. There is not yet a way to indicate priority. An up to date
59bug. There is not yet a way to indicate priority. An up to date
60summary of issues can be found [here](https://github.com/jgm/pandoc/labels).
60summary of issues can be found [here](https://github.com/jgm/pandoc/labels).
62+* [beginner-friendly] — The perfect starting point for new contributors. The
63+ issue is generic and can be resolved without deep knowledge of the code
62* [enhancement] — A feature which would be desirable. We recommend
65* [enhancement] — A feature which would be desirable. We recommend
63 you discuss any proposed enhancement on pandoc-discuss before
66 you discuss any proposed enhancement on pandoc-discuss before
64 writing code.
67 writing code.
65* [bug] — A problem which needs to be fixed.
68* [bug] — A problem which needs to be fixed.
66−* [minor] — The fix should only be a couple of lines.
69+* [complexity:low] — The fix should only be a couple of lines.
67−* [major] — The fix might require structural changes or in depth knowledge of
70+* [complexity:high] — The fix might require structural changes or in depth
68−the code base.
71+ knowledge of the code base.
69−* [reader] — A request to add a new input format.
72+* [new:reader] — A request to add a new input format.
70−* [writer] — A request to add a new output format.
73+* [new:writer] — A request to add a new output format.
71−* [docs] — A discrepency or ambiguity in the documentation.
74+* [docs] — A discrepency, or ambiguity in the documentation.
72−* [inprogress] — Someone is actively working on or planning to work on the
75+* [status:in-progress] — Someone is actively working on or planning to work on the
74−* [more discussion needed] — It is unclear what the correct approach
77+* [status:more-discussion-needed] — It is unclear what the correct approach
75 to solving the ticket is. Before starting on tickets such as this it
78 to solving the ticket is. Before starting on tickets such as this it
76 would be advisable to post on the ticket.
79 would be advisable to post on the ticket.
77−* [more info needed] — We require more information from a user before
80+* [status:more-info-needed] — We require more information from a user before
78 we can classify a report properly.
81 we can classify a report properly.
83+Issues related to a specific format are tagged accordingly, e.g. feature request
84+or bug reports related to Markdown are labelled with [format:markdown].
80Have an idea for a new feature?
86Have an idea for a new feature?
81-------------------------------
87-------------------------------
@@ -275,15 +281,17 @@ The library is structured as follows:
275[EditorConfig]: http://editorconfig.org/
281[EditorConfig]: http://editorconfig.org/
276[Haskell platform]: http://www.haskell.org/platform/
282[Haskell platform]: http://www.haskell.org/platform/
277[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
283[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
284+[beginner-friendly]: https://github.com/jgm/pandoc/labels/beginner-friendly
278[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
285[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
279[bug]: https://github.com/jgm/pandoc/labels/bug
286[bug]: https://github.com/jgm/pandoc/labels/bug
280−[minor]: https://github.com/jgm/pandoc/labels/Minor
287+[complexity:low]: https://github.com/jgm/pandoc/labels/complexity:low
281−[major]: https://github.com/jgm/pandoc/labels/Major
282−[reader]: https://github.com/jgm/pandoc/labels/Reader
288+[complexity:high]: https://github.com/jgm/pandoc/labels/complexity:high
283−[writer]: https://github.com/jgm/pandoc/labels/Writer
284[docs]: https://github.com/jgm/pandoc/labels/docs
289[docs]: https://github.com/jgm/pandoc/labels/docs
285−[inprogress]: https://github.com/jgm/pandoc/labels/inprogress
290+[format:markdown]: https://github.com/jgm/pandoc/labels/format:markdown
291+[new:reader]: https://github.com/jgm/pandoc/labels/new:reader
292+[new:writer]: https://github.com/jgm/pandoc/labels/new:writer
286−[more discussion needed]: https://github.com/jgm/pandoc/labels/More%20discussion%20needed
293+[status:in-progress]: https://github.com/jgm/pandoc/labels/status:in-progress
294+[status:more-discussion-needed]: https://github.com/jgm/pandoc/labels/status:more-discussion-needed
287−[more info needed]: https://github.com/jgm/pandoc/labels/More%20info%20needed
295+[status:more-info-needed]: https://github.com/jgm/pandoc/labels/status:more-info-needed
288[stack]: https://github.com/commercialhaskell/stack
296[stack]: https://github.com/commercialhaskell/stack