Mercurial > hg
annotate CONTRIBUTING @ 43625:8d9e2c2b6058
mail: add type hints for pytype
We essentially annotate functions in which handling of bytes/str is not
obvious in order to hopefully clear things out. See also changeset
2ade00f3b03b introducing typing hints in Mercurial.
Most types are straightforward but a few is wrong, and we need to
either disable pytype on respective instructions or use wrong
annotations. These will be fixed in next changesets. Notice the type
Union[bytes, str] of "s" parameter of headencode(), this reflects how
email.header.Header.append() behaves.
author | Denis Laxalde <denis@laxalde.org> |
---|---|
date | Wed, 13 Nov 2019 22:20:44 +0100 |
parents | a492610a2fc1 |
children |
rev | line source |
---|---|
30084
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
1 Our full contribution guidelines are in our wiki, please see: |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
2 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
3 https://www.mercurial-scm.org/wiki/ContributingChanges |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
4 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
5 If you just want a checklist to follow, you can go straight to |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
6 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
7 https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
8 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
9 If you can't run the entire testsuite for some reason (it can be |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
10 difficult on Windows), please at least run `contrib/check-code.py` on |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
11 any files you've modified and run `python contrib/check-commit` on any |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
12 commits you've made (for example, `python contrib/check-commit |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
13 273ce12ad8f1` will report some style violations on a very old commit). |