diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11a0c9c94..372caf0ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,13 +144,10 @@ Please follow these guidelines: 9. It is better not to introduce new dependencies. Dependencies on external C libraries should especially be avoided. -10. We aim for compatibility with ghc versions from 7.8.3 to the +10. We aim for compatibility with ghc versions from 7.10.3 to the latest release. All pull requests and commits are tested automatically on <travis-ci.org>, using GHC versions in the - `Tested-With` stanza of `pandoc.cabal`. We currently relax - the "`-Wall` clean" requirement for GHC 7.10.x, because - there are so many warnings relating to the addition of type - classes to the Prelude. + `Tested-With` stanza of `pandoc.cabal`. Tests ----- @@ -192,7 +189,7 @@ Using the REPL With a recent version of cabal, you can do `cabal repl` and get a ghci REPL for working with pandoc. With [stack], use -`cabal ghci`. +`stack ghci`. We recommend using the following `.ghci` file (which can be placed in the source directory): @@ -267,7 +264,7 @@ The library is structured as follows: - `Text.Pandoc.Definition` (in `pandoc-types`) defines the types used for representing a pandoc document. - `Text.Pandoc.Builder` (in `pandoc-types`) provides functions for - building pandoc documents programatically. + building pandoc documents programmatically. - `Text.Pandoc.Generics` (in `pandoc-types`) provides functions allowing you to promote functions that operate on parts of pandoc documents to functions that operate on whole pandoc documents, walking the @@ -306,6 +303,13 @@ The library is structured as follows: - `Text.Pandoc.UUID` contains functions for generating UUIDs. - `Text.Pandoc.XML` contains functions for formatting XML. +Lua filters +----------- + +If you've written a useful pandoc [lua filter](lua-filters.html), +you may want to consider submitting a pull request to the +[lua-filters repository](https://github.com/pandoc/lua-filters). + [open issues]: https://github.com/jgm/pandoc/issues [closed issues]: https://github.com/jgm/pandoc/issues?q=is%3Aissue+is%3Aclosed [latest released version]: https://github.com/jgm/pandoc/releases/latest |