Skip to content

Commit 0e81cc9

Browse files
committed
Update SubmittingPatches
- The SubmittingPatches document is updated with the current mailing list ([email protected]). - Note that patches may be submitted as pull requests to the GitHub repo. - Identify `make lint` and `make test` as the prescribed pre-submission steps. Signed-off-by: Peter Grayson <[email protected]>
1 parent 763a708 commit 0e81cc9

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

Documentation/SubmittingPatches

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
IMPORTANT: The StGit mailing list is no longer available due to the
2-
shutdown of the gna.org website. Until a decision is made on
3-
setting up a new mailing list, please send patches to
4-
[email protected] or via the project page at
5-
https://github.com/ctmarinas/stgit.
6-
71
Checklist (and a short version for the impatient):
82

93
Commits:
104

115
- Make commits of logical units.
12-
- Check for unnecessary whitespace with "git diff --check"
13-
before committing.
6+
- Run "make lint" before committing.
147
- Do not check in commented out code or unneeded files.
158
- Provide a meaningful commit message.
169
- The first line of the commit message should be a short
@@ -21,17 +14,18 @@ Checklist (and a short version for the impatient):
2114
committing) to confirm that you agree to the Developer's
2215
Certificate of Origin.
2316
- Make sure that you have tests for the bug you are fixing.
24-
- Make sure that the test suite passes after your commit.
17+
- Make sure that the test suite passes after your commit
18+
with "make test".
2519

2620
Patch:
2721

2822
- Preferably use "stg mail" to send patches. The first time,
2923
it's a good idea to try to mail the patches to yourself to
3024
see that everything works.
3125
- Do not PGP sign your patch.
32-
- Do not attach your patch, but read in the mail.
33-
body, unless you cannot teach your mailer to
34-
leave the formatting of the patch alone.
26+
- Do not attach your patch, but inline in the mail body,
27+
unless you cannot teach your mailer to leave the formatting
28+
of the patch alone.
3529
- Be careful doing cut & paste into your mailer, not to
3630
corrupt whitespaces.
3731
- Provide additional information (which is unsuitable for the
@@ -43,9 +37,11 @@ Checklist (and a short version for the impatient):
4337
documentation should be updated as well.
4438
- If your name is not writable in ASCII, make sure that
4539
you send off a message in the correct encoding.
46-
- Send the patch to the list (TBD) and the
47-
maintainer ([email protected]) if (and only if) the
48-
patch is ready for inclusion.
40+
- Make a pull request at the GitHub repo
41+
(https://github.com/ctmarinas/stgit) or send the patch to
42+
the list ([email protected]) and the maintainer
43+
([email protected]) if (and only if) the patch is
44+
ready for inclusion.
4945

5046

5147
Long version:
@@ -64,8 +60,9 @@ Long version:
6460
If your description starts to get too long, that's a sign that you
6561
probably need to split up your commit to finer grained pieces.
6662

67-
Oh, another thing. I am picky about whitespaces. Please run git
68-
diff --check on your changes before you commit.
63+
The stgit code should conform to PEP-8 standards. Please run
64+
"make lint" to make sure the code meets these standards. The lint
65+
requires that flake8 and isort be installed.
6966

7067

7168
2. Generate your patch using Git tools out of your commits.
@@ -87,15 +84,20 @@ Long version:
8784

8885
3. Sending your patches.
8986

87+
Changes to StGit may be either submitted by creating a pull request
88+
for the project on GitHub (https://github.com/ctmarinas/stgit) or
89+
by sending patches via email. The email process is detailed below.
90+
9091
StGit patches should be sent to the StGit mailing list
91-
(TBD), and preferably CCed to the StGit maintainer
92-
([email protected]). The recipients need to be able to read
93-
and comment on the changes you are submitting. It is important for
94-
a developer to be able to "quote" your changes, using standard
95-
e-mail tools, so that they may comment on specific portions of your
96-
code. For this reason, all patches should be submitted "inline".
97-
WARNING: Be wary of your MUAs word-wrap corrupting your patch. Do
98-
not cut-n-paste your patch; you can lose tabs that way if you are
92+
([email protected]), and preferably CCed to the StGit
93+
maintainer ([email protected]). The recipients need to be
94+
able to read and comment on the changes you are submitting. It is
95+
important for a developer to be able to "quote" your changes, using
96+
standard e-mail tools, so that they may comment on specific
97+
portions of your code. For this reason, all patches should be
98+
submitted "inline". WARNING: Be wary of your MUAs word-wrap
99+
corrupting your patch. Do not cut-n-paste your patch; you can lose
100+
tabs that way if you are
99101
not careful.
100102

101103
It is a common convention to prefix your subject line with [StGit

0 commit comments

Comments
 (0)