git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: larsxschneider@gmail.com
To: git@vger.kernel.org
Cc: mhagger@alum.mit.edu, Lars Schneider <larsxschneider@gmail.com>
Subject: [PATCH v1] Documentation: add setup instructions for Travis CI
Date: Wed, 13 Apr 2016 07:49:31 +0200	[thread overview]
Message-ID: <1460526571-93634-1-git-send-email-larsxschneider@gmail.com> (raw)

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

             reply	other threads:[~2016-04-13  5:49 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-13  5:49 larsxschneider [this message]
2016-04-13 17:39 ` [PATCH v1] Documentation: add setup instructions for Travis CI Junio C Hamano
2016-04-13 17:56   ` Stefan Beller
2016-04-14  9:14     ` Matthieu Moy
2016-04-14 17:45       ` Junio C Hamano
2016-04-16 15:29   ` Lars Schneider
2016-05-02  8:12     ` [PATCH v2] " larsxschneider
2016-05-02  8:48       ` Matthieu Moy
2016-05-02 17:21         ` Junio C Hamano
2016-05-03  8:09         ` Lars Schneider

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1460526571-93634-1-git-send-email-larsxschneider@gmail.com \
    --to=larsxschneider@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=mhagger@alum.mit.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).