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