aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThéo Zimmermann2019-07-10 18:07:32 +0200
committerThéo Zimmermann2019-07-11 09:55:20 +0200
commit5e95f92a6b5aa629a468f8164d87634a96b405ea (patch)
tree0fcdc57d2bee10b820a4979ee126d1864d0f66d3
parenta15a0a05e02bab2ed3877d45555b5224605db8de (diff)
Refactor the part about contributing to the stdlib.
- Remove reference to the age of the stdlib - Remove reference to stdlib2 until it accepts contributions - Merge two paragraphs together - Minor wording improvements
-rw-r--r--CONTRIBUTING.md22
1 files changed, 7 insertions, 15 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 89f99b7c2c..529a912bb6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -597,22 +597,15 @@ look in particular at the "Writing" and "Fixing" columns).
Contributing to the standard library is also made easier by not having
to learn about Coq's internals, and its implementation language.
-However, you should be aware that, because of the age of the library,
-and the compatibility constraints created by the many projects that
+Due to the compatibility constraints created by the many projects that
depend on it, proposing breaking changes, such as changing a
definition, may frequently be rejected, or at the very least might
-take a long time before getting approved and merged. This does not
-mean that you cannot try.
-
-There exists a [stdlib2][] project, that will be much more open to
-compatibility-breaking changes once it starts accepting external
-contributions.
-
-In the meantime, contributing new lemmas on existing definitions
-should be generally favorably accepted, cleaning up existing proofs as
-well. Contributing new operations on existing types is also likely to
-be accepted in many cases. In case of doubt, ask in an issue before
-spending too much time preparing your PR.
+take a long time before getting approved and merged. This does not
+mean that you cannot try. On the other hand, contributing new lemmas
+on existing definitions and cleaning up existing proofs are likely to
+be accepted. Contributing new operations on existing types are also
+likely to be accepted in many cases. In case of doubt, ask in an
+issue before spending too much time preparing your PR.
If you create a new file, it needs to be listed in
`doc/stdlib/index-list.html`.
@@ -1116,7 +1109,6 @@ can be found [on the wiki][wiki-CUDW].
[RM-checklist]: dev/doc/release-process.md
[Stack-Exchange]: https://stackexchange.com/filters/299857/questions-tagged-coq-on-stackexchange-sites
[Stack-Overflow]: https://stackoverflow.com/questions/tagged/coq
-[stdlib2]: https://github.com/coq/stdlib2
[stdlib-doc]: https://coq.inria.fr/stdlib/
[test-suite-README]: test-suite/README.md
[tools-website]: https://coq.inria.fr/related-tools.html