1*5971e316Smrg[Mostly copied from git's SubmittingPatches] 2*5971e316Smrg 3*5971e316Smrg Commits: 4*5971e316Smrg 5*5971e316Smrg - make commits of logical units 6*5971e316Smrg - check for unnecessary whitespace with "git diff --check" 7*5971e316Smrg before committing 8*5971e316Smrg - do not check in commented out code or unneeded files 9*5971e316Smrg - the first line of the commit message should be a short 10*5971e316Smrg description and should skip the full stop 11*5971e316Smrg - the body should provide a meaningful commit message, which 12*5971e316Smrg includes motivation for the change, and contrasts 13*5971e316Smrg its implementation with previous behaviour 14*5971e316Smrg - the lines of this body should have at most 76 columns 15*5971e316Smrg - if you want your work included in isl.git, add a 16*5971e316Smrg "Signed-off-by: Your Name <you@example.com>" line to the 17*5971e316Smrg commit message (or just use the option "-s" when 18*5971e316Smrg committing) to confirm that you agree to the Developer's 19*5971e316Smrg Certificate of Origin 20*5971e316Smrg - make sure that you have tests for the bug you are fixing 21*5971e316Smrg - make sure that the test suite passes after your commit 22*5971e316Smrg 23*5971e316Smrg Patch: 24*5971e316Smrg 25*5971e316Smrg - use "git format-patch -M" to create the patch 26*5971e316Smrg - do not PGP sign your patch 27*5971e316Smrg - send a single patch per mail, e.g., using git-send-email(1) 28*5971e316Smrg - do not attach your patch, but read in the mail 29*5971e316Smrg body, unless you cannot teach your mailer to 30*5971e316Smrg leave the formatting of the patch alone. 31*5971e316Smrg - be careful doing cut & paste into your mailer, not to 32*5971e316Smrg corrupt whitespaces. 33*5971e316Smrg - provide additional information (which is unsuitable for 34*5971e316Smrg the commit message) between the "---" and the diffstat 35*5971e316Smrg - if you change, add, or remove a command line option or 36*5971e316Smrg make some other user interface change, the associated 37*5971e316Smrg documentation should be updated as well. 38*5971e316Smrg - if your name is not writable in ASCII, make sure that 39*5971e316Smrg you send off a message in the correct encoding. 40*5971e316Smrg - send the patch to the development mailing list 41*5971e316Smrg (isl-development@googlegroups.com). If you use 42*5971e316Smrg git-send-email(1), please test it first by sending email 43*5971e316Smrg to yourself. 44*5971e316Smrg 45*5971e316Smrg Revisions: 46*5971e316Smrg 47*5971e316Smrg - add the revision number inside square brackets to 48*5971e316Smrg the subject line (e.g., use --subject-prefix='PATCH v2' 49*5971e316Smrg when creating the patch) 50*5971e316Smrg - recall the major issues discovered during the previous 51*5971e316Smrg review and explain how you addressed them or why you 52*5971e316Smrg disagree. Do so either in a cover letter, between the 53*5971e316Smrg "---" and the diffstat or in a separate message. 54