[PATCH v1] Documentation: add setup instructions for Travis CI
From: Lars Schneider <larsxschneider@gmail.com>
Signed-off-by: Lars Schneider <larsxschneider@gmail.com>
---
Documentation/SubmittingPatches | 39 ++++++++++++++++++++++++++++++++++++---
1 file changed, 36 insertions(+), 3 deletions(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 98fc4cc..79e9b33 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -63,10 +63,43 @@ t/README for guidance.
When adding a new feature, make sure that you have new tests to show
the feature triggers the new behaviour when it should, and to show the
feature does not trigger when it shouldn't. Also make sure that the
-test suite passes after your commit. Do not forget to update the
-documentation to describe the updated behaviour.
+test suite passes after your commit.
-Speaking of the documentation, it is currently a liberal mixture of US
+We recommend to use our CI infrastructure to ensure your new feature
+passes all existing tests as well as your new tests on Linux, Mac, and
+(hopefully soon) Windows. Follow these steps for the initial setup:
+
+ (1) Sign in to GitHub: https://github.com
+ Please sign up first if you haven't already, it's free.
+
+ (2) Fork https://github.com/git/git to your GitHub account
+ Details: https://help.github.com/articles/fork-a-repo/
+
+ (3) Go to Travis CI: https://travis-ci.org
+
+ (4) Press the "Sign in with GitHub" button
+
+ (5) Grant Travis CI permissions to access your GitHub account
+ Details: https://docs.travis-ci.com/user/github-oauth-scopes
+
+ (6) Go to your Travis CI profile page: https://travis-ci.org/profile
+
+ (7) Enable Travis CI builds for your Git fork
+
+After the initial setup you can push your new feature branches to your
+Git fork on GitHub and check if they pass all tests here:
+https://travis-ci.org/<Your GitHub handle>/git/branches
+
+If they don't pass then they are marked "red". If that happens then
+click on the failing Travis CI job and scroll all the way down in the
+log. Find the line "<-- Click here to see detailed test output!" and
+click on the triangle next to the log line number to expand the detailed
+test output (example: https://travis-ci.org/git/git/jobs/122676187).
+Fix the problem and push an updated commit to your branch to ensure
+all tests pass.
+
+Do not forget to update the documentation to describe the updated
+behaviour of your new feature. It is currently a liberal mixture of US
and UK English norms for spelling and grammar, which is somewhat
unfortunate. A huge patch that touches the files all over the place
only to correct the inconsistency is not welcome, though. Potential
--
2.5.1
larsxschneider@gmail.com <larsxschneider@gmail.com>