Blame isl-0.16.1/doc/SubmittingPatches

Packit fb9d21
[Mostly copied from git's SubmittingPatches]
Packit fb9d21
Packit fb9d21
	Commits:
Packit fb9d21
Packit fb9d21
	- make commits of logical units
Packit fb9d21
	- check for unnecessary whitespace with "git diff --check"
Packit fb9d21
	  before committing
Packit fb9d21
	- do not check in commented out code or unneeded files
Packit fb9d21
	- the first line of the commit message should be a short
Packit fb9d21
	  description and should skip the full stop
Packit fb9d21
	- the body should provide a meaningful commit message, which
Packit fb9d21
	  includes motivation for the change, and contrasts
Packit fb9d21
	  its implementation with previous behaviour
Packit fb9d21
	- if you want your work included in isl.git, add a
Packit fb9d21
	  "Signed-off-by: Your Name <you@example.com>" line to the
Packit fb9d21
	  commit message (or just use the option "-s" when
Packit fb9d21
	  committing) to confirm that you agree to the Developer's
Packit fb9d21
	  Certificate of Origin
Packit fb9d21
	- make sure that you have tests for the bug you are fixing
Packit fb9d21
	- make sure that the test suite passes after your commit
Packit fb9d21
Packit fb9d21
	Patch:
Packit fb9d21
Packit fb9d21
	- use "git format-patch -M" to create the patch
Packit fb9d21
	- do not PGP sign your patch
Packit fb9d21
	- send a single patch per mail, e.g., using git-send-email(1)
Packit fb9d21
	- do not attach your patch, but read in the mail
Packit fb9d21
	  body, unless you cannot teach your mailer to
Packit fb9d21
	  leave the formatting of the patch alone.
Packit fb9d21
	- be careful doing cut & paste into your mailer, not to
Packit fb9d21
	  corrupt whitespaces.
Packit fb9d21
	- provide additional information (which is unsuitable for
Packit fb9d21
	  the commit message) between the "---" and the diffstat
Packit fb9d21
	- if you change, add, or remove a command line option or
Packit fb9d21
	  make some other user interface change, the associated
Packit fb9d21
	  documentation should be updated as well.
Packit fb9d21
	- if your name is not writable in ASCII, make sure that
Packit fb9d21
	  you send off a message in the correct encoding.
Packit fb9d21
	- send the patch to the development mailing list
Packit fb9d21
	  (isl-development@googlegroups.com).  If you use
Packit fb9d21
	  git-send-email(1), please test it first by sending email
Packit fb9d21
	  to yourself.
Packit fb9d21
Packit fb9d21
	Revisions:
Packit fb9d21
Packit fb9d21
	- add the revision number inside square brackets to
Packit fb9d21
	  the subject line (e.g., use --subject-prefix='PATCH v2'
Packit fb9d21
	  when creating the patch)
Packit fb9d21
	- recall the major issues discovered during the previous
Packit fb9d21
	  review and explain how you addressed them or why you
Packit fb9d21
	  disagree.  Do so either in a cover letter, between the
Packit fb9d21
	  "---" and the diffstat or in a separate message.