aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaxime Dénès2017-08-16 09:39:53 +0200
committerMaxime Dénès2017-08-16 09:39:53 +0200
commit75b69fd5bb32e89b565551b96ca8d02d2d16ae62 (patch)
tree422e6358d55e4ad3bb0c80c7cf0f2ab715663420
parent335f219436fd1106884a0f135826a53f01801728 (diff)
parent27498bb9efcd6cefe7847595be4a61a033c84266 (diff)
Merge PR #944: Fix typos. Improve wording.
-rw-r--r--README.ci.md38
1 files changed, 25 insertions, 13 deletions
diff --git a/README.ci.md b/README.ci.md
index 9e25390d72..cf9da50941 100644
--- a/README.ci.md
+++ b/README.ci.md
@@ -1,30 +1,42 @@
**WARNING:** This document is a work in progress and intended as a RFC.
-If you are not a Coq Developer, don't follow this instructions yet.
+If you are not a Coq Developer, don't follow these instructions yet.
Introduction
============
-The Coq Travis CI infrastructure is meant to provide lightweight
-automatics testing of pull requests.
-If you are on GitLab, their integrated CI is also set up.
+As of 2017, Coq's Git repository includes a `.travis.yml` file, a
+`.gitlab-ci.yml` file, and supporting scripts, that enable lightweight
+Continuous Integration (CI) tests to be run on clones of that repository stored
+at Github or on a GitLab instance, respectively. This affords two benefits.
-More comprehensive testing is the responsability of Coq's [Jenkins CI
-server](https://ci.inria.fr/coq/) see, [XXX: add document] for
-instructions on how to add your development to Jenkins.
+First, it allows developers working on Coq itself to perform CI on their own
+Git remotes, thereby enabling them to catch and fix problems with their
+proposed changes before submitting pull requests to Coq itself. This in turn
+reduces the risk of a faulty PR being opened against the official Coq
+repository.
-How to submit your development for Coq CI
-=========================================
+Secondly, it allows developers working on a library dependent on Coq to have
+that library included in the Travis CI tests invoked by the official Coq
+repository on GitHub.
+
+(More comprehensive testing than is provided by the Travis CI and GitLab CI
+integration is the responsibility of Coq's [Jenkins CI
+server](https://ci.inria.fr/coq/) see, [XXX: add document] for instructions on
+how to add your development to Jenkins.)
+
+How to submit your library for inclusion in Coq's Travis CI builds
+==================================================================
CI provides a convenient way to perform testing of Coq changes
versus a set of curated libraries.
Are you an author of a Coq library who would be interested in having
-the latest Coq changes validated against your development?
+the latest Coq changes validated against it?
-If so, keep reading! Getting Coq changes tested against your library
-is easy, all that you need to do is:
+If so, all you need to do is:
-1. Put you development in a public repository tracking coq trunk.
+1. Put your library in a public repository tracking the `master`
+ branch of Coq's Git repository.
2. Make sure that your development builds in less than 35 minutes.
3. Submit a PR adding your development.
4. ?