From 94c50815caf4c57b77ed761e05dc707f48685c65 Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Thu, 10 Aug 2017 08:07:19 +0100 Subject: Add a set of contributing guidelines Heavily inspired by the Rust guidelines (https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md). --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..55eb0fbdb0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to Coq + +Thank you for your interest in contributing to Coq! There are many ways to contribute, and we appreciate all of them. + +## Bug Reports + +Bug reports are enormously useful to identify issues with Coq; we can't fix what we don't know about. Bug reports should all be filed on the [Coq Bugzilla](https://coq.inria.fr/bugs/) (you'll have to make an account). You can file a bug for any of the following: + +- An anomaly. These are always considered bugs, so Coq will even ask you to file a bug report! +- An error you didn't expect. If you're not sure whether it's a bug or intentional, feel free to file a bug anyway. We may want to improve the documentation or error message. +- An error message that wasn't as helpful as you'd like. Bonus points for suggesting what information would have helped you. +- Bugs in CoqIDE should also be filed on the Bugzilla. Bugs in the Emacs plugin should be filed against [ProofGeneral](https://github.com/ProofGeneral/PG/issues), or against [company-coq](https://github.com/cpitclaudel/company-coq/issues) if they are specific to company-coq features. + +It would help if you searched the existing issues to see if someone has already reported your error. This can be difficult and the search feature isn't as powerful as we'd like, so consider this extra credit. We don't mind duplicate bug reports. + +When it applies, it's extremely helpful for bug reports to include sample code, and much better if the code is self-contained and complete. It's not necessary to minimize your bug or identify precisely where the issue is, since someone else can often do this if you include a complete example. We tend to include the code in the bug description itself, but if you have a very large input file then you can add it as an attachment. + +## Pull requests + +Sometimes you able to contribute a bug fix or improvement yourself, and pull requests are the mechanism to get these changes into Coq. + +Please make pull requests against the `master` branch. + +It's helpful to run the Coq test suite with `make -C test-suite` before submitting your change. Travis CI runs this test suite and a much larger one 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. + +Don't be alarmed if pull requests take some time. It can take a few days to get feedback, approval on the final changes, and then a merge. Coq doesn't release new versions very frequently so it can take a few months for your change to land in a released version. That said, you can start using the latest Coq `master` branch to take advantage of all the new features, improvements, and fixes. + +## Documentation + +Currently the process for contributing to the documentation is the same as for changing anything else in Coq, so please submit a pull request as described above. We hope to streamline this process eventually. -- cgit v1.2.3 From a1fc30e9d90885ed665e350c1ef4598e66f3d68d Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Thu, 10 Aug 2017 12:52:30 +0100 Subject: Amendments to contributing doc Incorporating some feedback from @Zimmi48 --- CONTRIBUTING.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55eb0fbdb0..89b845bd67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,7 @@ Bug reports are enormously useful to identify issues with Coq; we can't fix what - An anomaly. These are always considered bugs, so Coq will even ask you to file a bug report! - An error you didn't expect. If you're not sure whether it's a bug or intentional, feel free to file a bug anyway. We may want to improve the documentation or error message. +- Missing documentation. It's helpful to track where the documentation should be improved, so please file a bug if you can't find or don't understand some bit of documentation. - An error message that wasn't as helpful as you'd like. Bonus points for suggesting what information would have helped you. - Bugs in CoqIDE should also be filed on the Bugzilla. Bugs in the Emacs plugin should be filed against [ProofGeneral](https://github.com/ProofGeneral/PG/issues), or against [company-coq](https://github.com/cpitclaudel/company-coq/issues) if they are specific to company-coq features. @@ -17,14 +18,30 @@ When it applies, it's extremely helpful for bug reports to include sample code, ## Pull requests -Sometimes you able to contribute a bug fix or improvement yourself, and pull requests are the mechanism to get these changes into Coq. +Sometimes you are able to contribute a bug fix or improvement yourself, and pull requests are the mechanism to get these changes into Coq. Documentation for getting started with the Coq sources is located at `dev/doc`. Please make pull requests against the `master` branch. -It's helpful to run the Coq test suite with `make -C test-suite` before submitting your change. Travis CI runs this test suite and a much larger one 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. +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. -Don't be alarmed if pull requests take some time. It can take a few days to get feedback, approval on the final changes, and then a merge. Coq doesn't release new versions very frequently so it can take a few months for your change to land in a released version. That said, you can start using the latest Coq `master` branch to take advantage of all the new features, improvements, and fixes. +Don't be alarmed if the pull request process takes some time. It can take a few days to get feedback, approval on the final changes, and then a merge. Coq doesn't release new versions very frequently so it can take a few months for your change to land in a released version. That said, you can start using the latest Coq `master` branch to take advantage of all the new features, improvements, and fixes. + +Here are a few tags Coq developers may add to your PR and what they mean. In general feedback and requests for you as the pull request author will be in the comments and tags are only used to organize pull requests. + +- [needs: rebase](https://github.com/coq/coq/pulls?utf8=%E2%9C%93&q=is%3Aopen%20is%3Apr%20label%3A%22needs%3A%20rebase%22%20) indicates the PR should be rebased on top of the latest `master` branch. See the [GitHub documentation](https://help.github.com/articles/about-git-rebase/) for a brief introduction to using `git rebase`. +- [needs: fixing](https://github.com/coq/coq/pulls?q=is%3Aopen+is%3Apr+label%3A%22needs%3A+fixing%22) indicates the PR needs a fix, as discussed in the comments. +- [needs: testing](https://github.com/coq/coq/pulls?q=is%3Aopen+is%3Apr+label%3A%22needs%3A+testing%22) indicates the PR needs testing. This is often used when testing beyond what the test suite can handle is required. For example, performance benchmarking is currently performed with a different infrastructure. Unless some followup is specifically requested you aren't expected to do this additional testing. ## Documentation -Currently the process for contributing to the documentation is the same as for changing anything else in Coq, so please submit a pull request as described above. We hope to streamline this process eventually. +Currently the process for contributing to the documentation is the same as for changing anything else in Coq, so please submit a pull request as described above. + +Bugzilla includes a component to mark bugs related to documentation. You can view a list of documentation-related bugs using a [Bugzilla search](https://coq.inria.fr/bugs/buglist.cgi?component=Doc&list_id=455006&product=Coq&resolution=---). Many of these bugs can be fixed by contributing writing, without knowledge of Coq's OCaml source code. + +The sources for the [Coq reference manual](https://coq.inria.fr/distrib/current/refman/) are at [`doc/refman`](https://github.com/coq/coq/tree/master/doc/refman). These are written in LaTeX and compiled to HTML with [HeVeA](http://hevea.inria.fr/). + +## Contributing outside this repository + +There are many useful ways to contribute to the Coq ecosystem that don't involve the Coq repository. + +Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. We don't yet have a good process or home for these tutorials, but are open to suggestions. -- cgit v1.2.3 From de170f36c9b8e36810126fec82ff9cce2a2af2e7 Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Thu, 10 Aug 2017 13:41:32 +0100 Subject: Some more tweaks to contributing guide --- CONTRIBUTING.md | 6 ++++-- README.md | 4 ++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89b845bd67..983eb64a1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ When it applies, it's extremely helpful for bug reports to include sample code, ## Pull requests -Sometimes you are able to contribute a bug fix or improvement yourself, and pull requests are the mechanism to get these changes into Coq. Documentation for getting started with the Coq sources is located at `dev/doc`. +Sometimes you are able to contribute a bug fix or improvement yourself, and pull requests are the mechanism to get these changes into Coq. Documentation for getting started with the Coq sources is located at [`dev/doc`](/dev/doc). Please make pull requests against the `master` branch. @@ -38,10 +38,12 @@ Currently the process for contributing to the documentation is the same as for c Bugzilla includes a component to mark bugs related to documentation. You can view a list of documentation-related bugs using a [Bugzilla search](https://coq.inria.fr/bugs/buglist.cgi?component=Doc&list_id=455006&product=Coq&resolution=---). Many of these bugs can be fixed by contributing writing, without knowledge of Coq's OCaml source code. -The sources for the [Coq reference manual](https://coq.inria.fr/distrib/current/refman/) are at [`doc/refman`](https://github.com/coq/coq/tree/master/doc/refman). These are written in LaTeX and compiled to HTML with [HeVeA](http://hevea.inria.fr/). +The sources for the [Coq reference manual](https://coq.inria.fr/distrib/current/refman/) are at [`doc/refman`](/doc/refman). These are written in LaTeX and compiled to HTML with [HeVeA](http://hevea.inria.fr/). ## Contributing outside this repository There are many useful ways to contribute to the Coq ecosystem that don't involve the Coq repository. Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. We don't yet have a good process or home for these tutorials, but are open to suggestions. + +Subscribe to the [coq-club](https://coq.inria.fr/community) mailing list and answer questions there. Asking your own questions on the mailing list will also help others learn from the answers, which often come from experts in the community. diff --git a/README.md b/README.md index 1ae555d930..7a430ff70e 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,7 @@ Send your bug reports by filling a form at [coq.inria.fr/bugs](http://coq.inria. To be effective, bug reports should mention the OCaml version used to compile and run Coq, the Coq version (`coqtop -v`), the configuration used, and include a complete source example leading to the bug. + +## Contributing + +Guidelines for contributing to Coq in various ways are listed in the [contributor's guide](CONTRIBUTING.md). -- cgit v1.2.3 From 82ac0208b86c8a3a913e10c81208e0716d2d4bcf Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Thu, 10 Aug 2017 16:25:52 +0100 Subject: Describe pull requests a bit more precisely --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 983eb64a1c..2aaec12a9c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ When it applies, it's extremely helpful for bug reports to include sample code, ## Pull requests -Sometimes you are able to contribute a bug fix or improvement yourself, and pull requests are the mechanism to get these changes into Coq. Documentation for getting started with the Coq sources is located at [`dev/doc`](/dev/doc). +If you want to contribute a bug fix or feature yourself, pull requests on the [GitHub repository](https://github.com/coq/coq) are the way to contribute directly to the Coq implementation. Documentation for getting started with the Coq sources is located in various files in [`dev/doc`](/dev/doc) (for example, [debugging.txt](/dev/doc/debugging.txt)). Please make pull requests against the `master` branch. -- cgit v1.2.3 From 6b959ae5807a80ea27c5c7a14fe7c3495913257b Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Thu, 10 Aug 2017 17:54:55 +0100 Subject: Simplify a bit of wording --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2aaec12a9c..3e06e89ff4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Bug reports are enormously useful to identify issues with Coq; we can't fix what - An error message that wasn't as helpful as you'd like. Bonus points for suggesting what information would have helped you. - Bugs in CoqIDE should also be filed on the Bugzilla. Bugs in the Emacs plugin should be filed against [ProofGeneral](https://github.com/ProofGeneral/PG/issues), or against [company-coq](https://github.com/cpitclaudel/company-coq/issues) if they are specific to company-coq features. -It would help if you searched the existing issues to see if someone has already reported your error. This can be difficult and the search feature isn't as powerful as we'd like, so consider this extra credit. We don't mind duplicate bug reports. +It would help if you search the existing issues before reporting a bug. This can be difficult, so consider it extra credit. We don't mind duplicate bug reports. When it applies, it's extremely helpful for bug reports to include sample code, and much better if the code is self-contained and complete. It's not necessary to minimize your bug or identify precisely where the issue is, since someone else can often do this if you include a complete example. We tend to include the code in the bug description itself, but if you have a very large input file then you can add it as an attachment. -- cgit v1.2.3 From 42fb6930df1ae92b952d6333222ff05198bf8ef5 Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Sat, 12 Aug 2017 12:17:37 +0100 Subject: Link to the existing list of tutorials --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e06e89ff4..5797b83120 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,6 @@ The sources for the [Coq reference manual](https://coq.inria.fr/distrib/current/ There are many useful ways to contribute to the Coq ecosystem that don't involve the Coq repository. -Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. We don't yet have a good process or home for these tutorials, but are open to suggestions. +Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. Some tutorials listed on the [Coq website](https://coq.inria.fr/documentation). If you would like to add a link to this list, please create a pull request against the Coq website repository at https://github.com/coq/www. Subscribe to the [coq-club](https://coq.inria.fr/community) mailing list and answer questions there. Asking your own questions on the mailing list will also help others learn from the answers, which often come from experts in the community. -- cgit v1.2.3 From 2a4cea4a6197862b0b18e5f8716e53304eaa5323 Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Sat, 12 Aug 2017 12:53:12 +0100 Subject: Expand PR process explanation --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5797b83120..f915cd36d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,9 @@ When it applies, it's extremely helpful for bug reports to include sample code, ## Pull requests -If you want to contribute a bug fix or feature yourself, pull requests on the [GitHub repository](https://github.com/coq/coq) are the way to contribute directly to the Coq implementation. Documentation for getting started with the Coq sources is located in various files in [`dev/doc`](/dev/doc) (for example, [debugging.txt](/dev/doc/debugging.txt)). +If you want to contribute a bug fix or feature yourself, pull requests on the [GitHub repository](https://github.com/coq/coq) are the way to contribute directly to the Coq implementation. We recommend you create a fork of the repository on GitHub and push your changes to a new "topic branch" in that fork. From there you can follow the [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/) to get your changes reviewed and pulled into the Coq source repository. + +Documentation for getting started with the Coq sources is located in various files in [`dev/doc`](/dev/doc) (for example, [debugging.txt](/dev/doc/debugging.txt)). Please make pull requests against the `master` branch. @@ -44,6 +46,6 @@ The sources for the [Coq reference manual](https://coq.inria.fr/distrib/current/ There are many useful ways to contribute to the Coq ecosystem that don't involve the Coq repository. -Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. Some tutorials listed on the [Coq website](https://coq.inria.fr/documentation). If you would like to add a link to this list, please create a pull request against the Coq website repository at https://github.com/coq/www. +Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. Some tutorials are listed on the [Coq website](https://coq.inria.fr/documentation). If you would like to add a link to this list, please make a pull request against the Coq website repository at https://github.com/coq/www. Subscribe to the [coq-club](https://coq.inria.fr/community) mailing list and answer questions there. Asking your own questions on the mailing list will also help others learn from the answers, which often come from experts in the community. -- cgit v1.2.3 From 7ca2d409047f876f38036855259ae0fdc30dff3c Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Sat, 12 Aug 2017 16:08:52 +0100 Subject: Add some things Jason mentioned --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f915cd36d2..93921d7679 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,8 @@ It would help if you search the existing issues before reporting a bug. This can When it applies, it's extremely helpful for bug reports to include sample code, and much better if the code is self-contained and complete. It's not necessary to minimize your bug or identify precisely where the issue is, since someone else can often do this if you include a complete example. We tend to include the code in the bug description itself, but if you have a very large input file then you can add it as an attachment. +If you want to minimize your bug (or help minimize someone else's) for more extra credit, then you can use the [Coq bug minimizer](https://github.com/JasonGross/coq-tools) (specifically, the bug minimizer is the `find-bug.py` script in that repo). + ## Pull requests If you want to contribute a bug fix or feature yourself, pull requests on the [GitHub repository](https://github.com/coq/coq) are the way to contribute directly to the Coq implementation. We recommend you create a fork of the repository on GitHub and push your changes to a new "topic branch" in that fork. From there you can follow the [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/) to get your changes reviewed and pulled into the Coq source repository. @@ -49,3 +51,5 @@ There are many useful ways to contribute to the Coq ecosystem that don't involve Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. Some tutorials are listed on the [Coq website](https://coq.inria.fr/documentation). If you would like to add a link to this list, please make a pull request against the Coq website repository at https://github.com/coq/www. Subscribe to the [coq-club](https://coq.inria.fr/community) mailing list and answer questions there. Asking your own questions on the mailing list will also help others learn from the answers, which often come from experts in the community. + +Hang out on the Coq IRC channel, `irc://irc.freenode.net/#coq`, and help answer questions. -- cgit v1.2.3 From 82828d631453f612d5048e970b8f1bc874a647c9 Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Sat, 12 Aug 2017 17:28:38 +0100 Subject: Also mention Stack Exchange --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93921d7679..e57fd0c7e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,4 +52,6 @@ Tutorials to teach Coq, and especially to teach particular advanced features, wo Subscribe to the [coq-club](https://coq.inria.fr/community) mailing list and answer questions there. Asking your own questions on the mailing list will also help others learn from the answers, which often come from experts in the community. +Ask and answer questions on [Stack Exchange](https://stackexchange.com/filters/299857/questions-tagged-coq-on-stackexchange-sites) which has a helpful albeit small community of users. + Hang out on the Coq IRC channel, `irc://irc.freenode.net/#coq`, and help answer questions. -- cgit v1.2.3 From 2dc691c218cb9fef7b5ce58ee4fff615c2a6d2e0 Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Tue, 15 Aug 2017 10:52:31 +0100 Subject: Mention coqdev@ --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e57fd0c7e5..24b46ee0b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ If you want to minimize your bug (or help minimize someone else's) for more extr If you want to contribute a bug fix or feature yourself, pull requests on the [GitHub repository](https://github.com/coq/coq) are the way to contribute directly to the Coq implementation. We recommend you create a fork of the repository on GitHub and push your changes to a new "topic branch" in that fork. From there you can follow the [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/) to get your changes reviewed and pulled into the Coq source repository. -Documentation for getting started with the Coq sources is located in various files in [`dev/doc`](/dev/doc) (for example, [debugging.txt](/dev/doc/debugging.txt)). +Documentation for getting started with the Coq sources is located in various files in [`dev/doc`](/dev/doc) (for example, [debugging.txt](/dev/doc/debugging.txt)). For further help with the Coq sources, feel free to join the [Coq Gitter chat](https://gitter.im/coq/coq) and ask questions. You can also email the Coq development mailing list at `coqdev@inria.fr`. Please make pull requests against the `master` branch. -- cgit v1.2.3 From eae98b19ec3ae4f35fbe98678e82c1d9c9e0c387 Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Tue, 15 Aug 2017 11:04:19 +0100 Subject: Never mind, don't mention coqdev I don't really want to recommend that someone subscribes to ask a question. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 24b46ee0b5..ca8e94242b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ If you want to minimize your bug (or help minimize someone else's) for more extr If you want to contribute a bug fix or feature yourself, pull requests on the [GitHub repository](https://github.com/coq/coq) are the way to contribute directly to the Coq implementation. We recommend you create a fork of the repository on GitHub and push your changes to a new "topic branch" in that fork. From there you can follow the [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/) to get your changes reviewed and pulled into the Coq source repository. -Documentation for getting started with the Coq sources is located in various files in [`dev/doc`](/dev/doc) (for example, [debugging.txt](/dev/doc/debugging.txt)). For further help with the Coq sources, feel free to join the [Coq Gitter chat](https://gitter.im/coq/coq) and ask questions. You can also email the Coq development mailing list at `coqdev@inria.fr`. +Documentation for getting started with the Coq sources is located in various files in [`dev/doc`](/dev/doc) (for example, [debugging.txt](/dev/doc/debugging.txt)). For further help with the Coq sources, feel free to join the [Coq Gitter chat](https://gitter.im/coq/coq) and ask questions. Please make pull requests against the `master` branch. -- cgit v1.2.3 From 0202ebb164a4d9b57be8a6a057b654e2e75692e1 Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Fri, 18 Aug 2017 08:59:19 +0100 Subject: Advise contributors to use SE over coq-club --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca8e94242b..c6542f81c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,8 +50,6 @@ There are many useful ways to contribute to the Coq ecosystem that don't involve Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. Some tutorials are listed on the [Coq website](https://coq.inria.fr/documentation). If you would like to add a link to this list, please make a pull request against the Coq website repository at https://github.com/coq/www. -Subscribe to the [coq-club](https://coq.inria.fr/community) mailing list and answer questions there. Asking your own questions on the mailing list will also help others learn from the answers, which often come from experts in the community. - -Ask and answer questions on [Stack Exchange](https://stackexchange.com/filters/299857/questions-tagged-coq-on-stackexchange-sites) which has a helpful albeit small community of users. +Ask and answer questions on [Stack Exchange](https://stackexchange.com/filters/299857/questions-tagged-coq-on-stackexchange-sites) which has a helpful albeit small community of users. We are trying to ask and answer more questions on Stack Exchange rather than the `coq-club@inria.fr` mailing list since the answers are editable and easier to search for. Hang out on the Coq IRC channel, `irc://irc.freenode.net/#coq`, and help answer questions. -- cgit v1.2.3 From c3c47d95ac0949797b4272f2043bef63802ce2fb Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Fri, 18 Aug 2017 10:16:17 +0100 Subject: Don't mention coq-club at all --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6542f81c1..0a8224dda8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,6 +50,6 @@ There are many useful ways to contribute to the Coq ecosystem that don't involve Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. Some tutorials are listed on the [Coq website](https://coq.inria.fr/documentation). If you would like to add a link to this list, please make a pull request against the Coq website repository at https://github.com/coq/www. -Ask and answer questions on [Stack Exchange](https://stackexchange.com/filters/299857/questions-tagged-coq-on-stackexchange-sites) which has a helpful albeit small community of users. We are trying to ask and answer more questions on Stack Exchange rather than the `coq-club@inria.fr` mailing list since the answers are editable and easier to search for. +Ask and answer questions on [Stack Exchange](https://stackexchange.com/filters/299857/questions-tagged-coq-on-stackexchange-sites) which has a helpful albeit small community of users. Hang out on the Coq IRC channel, `irc://irc.freenode.net/#coq`, and help answer questions. -- cgit v1.2.3 From 2b4bdaa784b6db01f584b1a49e0887458da2b45b Mon Sep 17 00:00:00 2001 From: Tej Chajed Date: Fri, 18 Aug 2017 13:57:05 +0100 Subject: Don't belittle the size of the SE community --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a8224dda8..84e60352ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,6 +50,6 @@ There are many useful ways to contribute to the Coq ecosystem that don't involve Tutorials to teach Coq, and especially to teach particular advanced features, would be much appreciated. Some tutorials are listed on the [Coq website](https://coq.inria.fr/documentation). If you would like to add a link to this list, please make a pull request against the Coq website repository at https://github.com/coq/www. -Ask and answer questions on [Stack Exchange](https://stackexchange.com/filters/299857/questions-tagged-coq-on-stackexchange-sites) which has a helpful albeit small community of users. +Ask and answer questions on [Stack Exchange](https://stackexchange.com/filters/299857/questions-tagged-coq-on-stackexchange-sites) which has a helpful community of Coq users. Hang out on the Coq IRC channel, `irc://irc.freenode.net/#coq`, and help answer questions. -- cgit v1.2.3