59 Commits

Author SHA1 Message Date
Albert Krewinkel 94e8a650fb CONTRIBUTING.md: update modules overview 2021-06-07 20:10:56 +02:00
John MacFarlane c6e5cf2e74 Benchmark improvements.
* Build `+RTS -A256m -RTS` into default ghc-options for benchmark,
  so we don't have to specify this separately on the command line.
  This is necessary to get accurate benchmark results; otherwise
  we are largely measuring garbage collecting, some not related
  to the current benchmark.
* Switch back from gauge to tasty-bench.
* Allow specifying BASELINE file in 'make bench' for comparison
  (otherwise the latest is chosen by default).
* Remove obsolete reference to weigh-pandoc from CONTRIBUTING.md.
* Remove `-Rghc-timing` from 'make bench'.
2021-03-17 13:34:17 -07:00
Albert Krewinkel 84b7a15375 CONTRIBUTING: suggest using a cabal.project.local file (#7153) 2021-03-16 08:34:38 -07:00
Salim B fae6a204f1 Fix/update URLs and use HTTP**S** where possible (#7122) 2021-02-26 17:56:04 -08:00
John MacFarlane ea96bc52e4 CONTRIBUTING: note on GNU xargs 2021-01-12 21:53:39 -08:00
John MacFarlane 35cfe2d01b New advice for pre-commit filter.
Without `--diff-filter=MA` it will try to lint deletions,
and fail because the file is not present.
2020-12-18 12:18:23 -08:00
Benjamin Wuethrich 6abe406aea Fix typo in CONTRIBUTING.md 2020-12-18 21:00:34 +01:00
Albert Krewinkel 3a2d993165 CONTRIBUTING: add section "How can I help?" (#6892)
Also adds a paragraph aimed at highlighting the importance of feature
maintenance.
2020-11-27 09:13:02 -08:00
John MacFarlane ce606cb688 Fix pre-commit hook so it doesn't catch .latex+lhs extensions. 2020-11-25 16:09:50 -08:00
Albert Krewinkel 0777e45d9e CONTRIBUTING: describe hlint and how it's used (#6840) 2020-11-16 06:55:21 -08:00
Albert Krewinkel 371a7ff34b Remove Circle CI badge, references
CI checks run on GitHub Actions now.
2020-09-01 12:00:38 +02:00
Dmitry Volodin eeb4c1e5b6 Fix typo in CONTRIBUTING.md (#6584)
Againt -> against
And use GitHub instead of github everywhere
2020-08-01 10:19:32 -07:00
John MacFarlane 761e62c678 CONTRIBUTING.md: Advertise the official nightlies in GitHub actions.
Replaces #6500, thanks to @ickc.
2020-07-02 08:51:38 -07:00
Florian B c55651d761 Add info about command test naming to CONTRIBUTING
Added a paragraph about naming conventions for tests in `test/command/`
to the contributors guide. Advises to include issue number and/or
feature being tested.
2019-10-16 09:09:08 -07:00
John MacFarlane 1c35167c3a Small cleanups in Makefile. 2019-09-05 17:34:47 -07:00
John MacFarlane 72ddbf5994 CONTRIBUTING: make clear that --accept works for all golden tests...
not just docx.
2019-07-19 09:29:10 -07:00
John MacFarlane d4b2128d55 CONTRIBUTING.md: mention command tests. 2019-07-19 09:24:31 -07:00
Agustín Martín Barbero 145b4d5ad6 Improve CONTRIBUTING.md with information on tests (#5652)
from INSTALL.md and [elsewhere](https://github.com/jgm/pandoc/pull/4383#issuecomment-367379040)
2019-07-19 09:23:18 -07:00
John MacFarlane 3ecc8d154b Drop support for ghc < 8. 2019-03-27 11:38:24 -07:00
John MacFarlane a43c0bf54b CONTRIBUTING: replace reference to travis with circleci. 2019-03-27 11:27:56 -07:00
John MacFarlane 0178544ebe CONTRIBUTING.md: link to lua-filters repository.
See #4874.
2018-09-07 16:33:38 -07:00
Brian Leung 5823031796 Fix mistake in REPL instructions for stack. (#4849) 2018-08-21 20:37:15 -07:00
Alexander Krotov 41cf6d540f More spellcheck 2018-07-02 19:07:28 +03:00
John MacFarlane 37523e54d5 Update list of supported ghc versions. 2018-06-29 20:07:29 +02:00
John MacFarlane 6acec6bf34 CONTRIBUTING.md: added note about --trace. 2018-04-23 12:02:59 -07:00
Adam Brandizzi 8fa9912005 CONTRIBUTING.md: label was renamed. (#4310)
See https://groups.google.com/forum/#!msg/pandoc-discuss/mrFsj5RzNFA/Pnd3zubWBwAJ;context-place=searchin/pandoc-discuss/%22good$20first$20issue%22%7Csort:date
2018-01-28 11:17:26 -08:00
Kolen Cheung c03ce0f1cb partially undo b851c2a 2017-10-26 22:26:55 -07:00
Kolen Cheung 3eb65a5f0f CONTRIBUTING.md: update reference to a deprecated arg 2017-10-26 22:25:37 -07:00
Kolen Cheung b851c2acdc CONTRIBUTING.md: general proofread
grammar, uniform style, etc.
2017-10-26 17:56:28 -07:00
Kolen Cheung 33ecec6525 CONTRIBUTING.md: sync a quote from MANUAL.txt 2017-10-26 17:55:45 -07:00
Kolen Cheung b3607ec306 CONTRIBUTING.md: add links 2017-10-26 17:55:16 -07:00
Wandmalfarbe 8af838f98f Fixed typos in CONTRIBUTING.md (#3479) 2017-03-01 15:00:53 +01:00
John MacFarlane d7e25d203a Fixed typo in CONTRIBUTING.md.
Introduced by 9d91b8825f.
2017-02-26 22:20:15 +01:00
Mauro Bieg 9d91b8825f CONTRIBUTING.md add "ask on pandoc-discuss" 2017-02-26 00:12:08 +01:00
Or Neeman fa43e36449 Fix stale references to tests directory (#3469)
Some of the benchmarks were failing due to references to files in the
`tests` directory, which is now called `test`.  A search found other
references to it also.  This commit updates all these references.
2017-02-25 10:31:40 +01:00
John MacFarlane 3c8ccd2a9c Modified documentation now that submodule fetching isn't needed. 2017-02-20 21:07:59 +01:00
John MacFarlane 73f3736602 CONTRIBUTING: instructions for building weigh-pandoc. 2017-01-25 17:07:41 +01:00
John MacFarlane af2742a9cc Removed PROFILING, added profiling info to CONTRIBUTING.md. 2017-01-25 17:07:41 +01:00
John MacFarlane 9d781b1454 Updates to use skylighting rather than highlighting-kate.
So far this just reproduces capacity.

Later we'll be able to add features like warning
messages, dynamic loading of xml syntax definitions,
and dynamic loading of themes.
2016-12-23 18:07:49 -07:00
Albert Krewinkel 69f2734504 CONTRIBUTING: Describe labels currently used in issue tracker
The labels have changed over time, the list of labels is updated to
reflect the current set of labels used in the issue tracker.
2016-12-14 22:11:27 +01:00
ickc 07b3060403 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.
2016-11-24 10:02:36 +01:00
John MacFarlane b0df50f003 Minor changes to CONTRIBUTING.md. 2016-10-25 16:51:26 +02:00
Jesse Rosenthal 10567f2e5a Bump supported ghc version in CONTRIBUTING.md. 2016-09-02 09:18:10 -04:00
Albert Krewinkel a396003a31 Rename README to MANUAL.txt 2016-07-20 21:16:45 +02:00
John MacFarlane c0515e09d4 Added info on Stack to CONTRIBUTING.md. 2016-02-05 16:58:29 -08:00
Mathieu Duponchelle a3266001d1 CONTRIBUTING.md : update test enabling documentation
On my end, in a clean sandbox, I had to run this before I could run the tests, I'm a cabal / haskell noob so that might not be the best way to do so but :)
2016-02-05 21:28:41 +01:00
John MacFarlane 422606b06e Small tweak on CONTRIBUTING.md. 2015-10-10 15:46:05 -07:00
John MacFarlane 388fe3053a Added note to CONTRIBUTING.md about ghc versions and travis. 2015-08-15 09:43:14 -07:00
John MacFarlane f78b5a4a5a Clarified what is "out of scope" in README and CONTRIBUTING.md. 2015-08-08 15:18:31 -07:00
John MacFarlane e944c036cf Added section on REPL to CONTRIBUTING.md. 2015-07-15 12:13:51 -07:00