diff options
| author |  Théo Zimmermann <theo.zimmermann@univ-paris-diderot.fr> | 2018-01-02 16:00:29 +0100 |
|---|---|---|
| committer | Théo Zimmermann <theo.zimmermann@univ-paris-diderot.fr> | 2018-02-21 17:25:17 +0100 |
| commit | f28813cfe8cac0193553aa1d009c76b3d26e743e (patch) | |
| tree | 449ee6bec5ff7782256d1c64da1712d71a24efca /CONTRIBUTING.md | |
| parent | 7face8b53832621b733f900a4a92395c5ba97d34 (diff) | |
Mention the CREDITS file in CONTRIBUTING.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a769333c..450bae1be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,6 +26,8 @@ Documentation for getting started with the Coq sources is located in various fil Please make pull requests against the `master` branch. +If it's your first significant contribution to Coq (significant means: more than fixing a typo), your pull request should include a commit adding your name to the [`CREDITS`](/CREDITS) file (possibly with the name of your institution / employer if relevant to your contribution, an ORCID if you have one —you may log into https://orcid.org/ using your institutional account to get one—, and the year of your contribution). + It's helpful to run the Coq test suite with `make test-suite` before submitting your change. Travis CI runs this test suite and a much larger one including external Coq developments on every pull request, but these results take significantly longer to come back (on the order of a few hours). Running the test suite locally will take somewhere around 10-15 minutes. Refer to [`dev/ci/README.md`](/dev/ci/README.md#information-for-developers) for more information on Travis CI tests. If your pull request fixes a bug, please consider adding a regression test as well. See [`test-suite/README.md`](/test-suite/README.md) for how to do so. |