aboutsummaryrefslogtreecommitdiff
path: root/dev/ci/README.md
diff options
context:
space:
mode:
authorGaëtan Gilbert2018-10-30 21:44:25 +0100
committerGaëtan Gilbert2018-10-30 21:44:25 +0100
commitd32301dde8071acc914286c675b9749e27f368d2 (patch)
treecafcad3409648e40c44bcb8c3923885b5785157d /dev/ci/README.md
parent0ac673e562c34245e4e48efc428d808e917be79b (diff)
parentb33794516f4dd10edcb06be49c0202a9e056c26e (diff)
Merge PR #8750: [ci] [doc] Notes about branch names.
Diffstat (limited to 'dev/ci/README.md')
-rw-r--r--dev/ci/README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/dev/ci/README.md b/dev/ci/README.md
index 7853866f62..4709247549 100644
--- a/dev/ci/README.md
+++ b/dev/ci/README.md
@@ -26,7 +26,8 @@ our CI. This means that:
On the condition that:
-- At the time of the submission, your development works with Coq master branch.
+- At the time of the submission, your development works with Coq's
+ `master` branch.
- Your development is publicly available in a git repository and we can easily
send patches to you (e.g. through pull / merge requests).
@@ -60,6 +61,19 @@ performance benchmark. Currently this is done by providing an OPAM package
in https://github.com/coq/opam-coq-archive and opening an issue at
https://github.com/coq/coq-bench/issues.
+### Recommended branching policy.
+
+It is sometimes the case that you will need to maintain a branch of
+your development for particular Coq versions. This is in fact very
+likely if your development includes a Coq ML plugin.
+
+We thus recommend a branching convention that mirrors Coq's branching
+policy. Then, you would have a `master` branch that follows Coq's
+`master`, a `v8.8` branch that works with Coq's `v8.8` branch and so
+on.
+
+This convention will be supported by tools in the future to make some
+developer commands work more seamlessly.
Information for developers
--------------------------