@@ -61,23 +61,28 @@ Make sure that you have tests for the bug you are fixing. See
61
61
t/README for guidance.
62
62
63
63
When adding a new feature, make sure that you have new tests to show
64
- the feature triggers the new behaviour when it should, and to show the
65
- feature does not trigger when it shouldn't. Also make sure that the
66
- test suite passes after your commit. Do not forget to update the
67
- documentation to describe the updated behaviour.
68
-
69
- Speaking of the documentation, it is currently a liberal mixture of US
70
- and UK English norms for spelling and grammar, which is somewhat
71
- unfortunate. A huge patch that touches the files all over the place
72
- only to correct the inconsistency is not welcome, though. Potential
73
- clashes with other changes that can result from such a patch are not
74
- worth it. We prefer to gradually reconcile the inconsistencies in
75
- favor of US English, with small and easily digestible patches, as a
76
- side effect of doing some other real work in the vicinity (e.g.
77
- rewriting a paragraph for clarity, while turning en_UK spelling to
78
- en_US). Obvious typographical fixes are much more welcomed ("teh ->
79
- "the"), preferably submitted as independent patches separate from
80
- other documentation changes.
64
+ the feature triggers the new behavior when it should, and to show the
65
+ feature does not trigger when it shouldn't. After any code change, make
66
+ sure that the entire test suite passes.
67
+
68
+ If you have an account at GitHub (and you can get one for free to work
69
+ on open source projects), you can use their Travis CI integration to
70
+ test your changes on Linux, Mac (and hopefully soon Windows). See
71
+ GitHub-Travis CI hints section for details.
72
+
73
+ Do not forget to update the documentation to describe the updated
74
+ behavior and make sure that the resulting documentation set formats
75
+ well. It is currently a liberal mixture of US and UK English norms for
76
+ spelling and grammar, which is somewhat unfortunate. A huge patch that
77
+ touches the files all over the place only to correct the inconsistency
78
+ is not welcome, though. Potential clashes with other changes that can
79
+ result from such a patch are not worth it. We prefer to gradually
80
+ reconcile the inconsistencies in favor of US English, with small and
81
+ easily digestible patches, as a side effect of doing some other real
82
+ work in the vicinity (e.g. rewriting a paragraph for clarity, while
83
+ turning en_UK spelling to en_US). Obvious typographical fixes are much
84
+ more welcomed ("teh -> "the"), preferably submitted as independent
85
+ patches separate from other documentation changes.
81
86
82
87
Oh, another thing. We are picky about whitespaces. Make sure your
83
88
changes do not trigger errors with the sample pre-commit hook shipped
@@ -370,6 +375,47 @@ Know the status of your patch after submission
370
375
entitled "What's cooking in git.git" and "What's in git.git" giving
371
376
the status of various proposed changes.
372
377
378
+ --------------------------------------------------
379
+ GitHub-Travis CI hints
380
+
381
+ With an account at GitHub (you can get one for free to work on open
382
+ source projects), you can use Travis CI to test your changes on Linux,
383
+ Mac (and hopefully soon Windows). You can find a successful example
384
+ test build here: https://travis-ci.org/git/git/builds/120473209
385
+
386
+ Follow these steps for the initial setup:
387
+
388
+ (1) Fork https://github.com/git/git to your GitHub account.
389
+ You can find detailed instructions how to fork here:
390
+ https://help.github.com/articles/fork-a-repo/
391
+
392
+ (2) Open the Travis CI website: https://travis-ci.org
393
+
394
+ (3) Press the "Sign in with GitHub" button.
395
+
396
+ (4) Grant Travis CI permissions to access your GitHub account.
397
+ You can find more information about the required permissions here:
398
+ https://docs.travis-ci.com/user/github-oauth-scopes
399
+
400
+ (5) Open your Travis CI profile page: https://travis-ci.org/profile
401
+
402
+ (6) Enable Travis CI builds for your Git fork.
403
+
404
+ After the initial setup, Travis CI will run whenever you push new changes
405
+ to your fork of Git on GitHub. You can monitor the test state of all your
406
+ branches here: https://travis-ci.org/<Your GitHub handle>/git/branches
407
+
408
+ If a branch did not pass all test cases then it is marked with a red
409
+ cross. In that case you can click on the failing Travis CI job and
410
+ scroll all the way down in the log. Find the line "<-- Click here to see
411
+ detailed test output!" and click on the triangle next to the log line
412
+ number to expand the detailed test output. Here is such a failing
413
+ example: https://travis-ci.org/git/git/jobs/122676187
414
+
415
+ Fix the problem and push your fix to your Git fork. This will trigger
416
+ a new Travis CI build to ensure all tests pass.
417
+
418
+
373
419
------------------------------------------------
374
420
MUA specific hints
375
421
0 commit comments