You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+63-7Lines changed: 63 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -67,12 +67,68 @@ poetry run python3 -m black src --check
67
67
Remove the `--check` flag to write reformatted files to disk.
68
68
69
69
To simplify reviews you can format your changes in a separate commit.
70
-
## Pull Request Process
71
70
72
-
1. Update the [CHANGELOG.md](README.md) or similar documentation with details of changes you wish to make, if applicable.
73
-
2. Add any appropriate tests.
74
-
3. Make your code or other changes.
75
-
4. Review guidelines such as
76
-
[How to write the perfect pull request][github-perfect-pr], thanks!
71
+
## Communication
72
+
Before starting work on a major feature, please reach out to us via GitHub, Slack, email, etc. We will make sure no one else is already working on it and ask you to open a GitHub issue.
73
+
A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior.
74
+
We will use the GitHub issue to discuss the feature and come to agreement.
75
+
This is to prevent your time being wasted, as well as ours.
76
+
The GitHub review process for major features is also important so that organizations with commit access can come to agreement on design.
77
+
If it is appropriate to write a design document, the document must be hosted either in the GitHub tracking issue, or linked to from the issue and hosted in a world-readable location.
78
+
Specifically, if the goal is to add a new extension, please read the extension policy.
79
+
Small patches and bug fixes don't need prior communication.
We follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) with one exception: lines can be up to 100 characters in length, not 79.
83
+
84
+
## Sign your work
85
+
The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):
86
+
87
+
```
88
+
Developer Certificate of Origin
89
+
Version 1.1
90
+
91
+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
92
+
1 Letterman Drive
93
+
Suite D4700
94
+
San Francisco, CA, 94129
95
+
96
+
Everyone is permitted to copy and distribute verbatim copies of this
97
+
license document, but changing it is not allowed.
98
+
99
+
100
+
Developer's Certificate of Origin 1.1
101
+
102
+
By making a contribution to this project, I certify that:
103
+
104
+
(a) The contribution was created in whole or in part by me and I
105
+
have the right to submit it under the open source license
106
+
indicated in the file; or
107
+
108
+
(b) The contribution is based upon previous work that, to the best
109
+
of my knowledge, is covered under an appropriate open source
110
+
license and I have the right under that license to submit that
111
+
work with modifications, whether created in whole or in part
112
+
by me, under the same open source license (unless I am
113
+
permitted to submit under a different license), as indicated
114
+
in the file; or
115
+
116
+
(c) The contribution was provided directly to me by some other
117
+
person who certified (a), (b) or (c) and I have not modified
118
+
it.
119
+
120
+
(d) I understand and agree that this project and the contribution
121
+
are public and that a record of the contribution (including all
122
+
personal information I submit with it, including my sign-off) is
123
+
maintained indefinitely and may be redistributed consistent with
124
+
this project or the open source license(s) involved.
125
+
```
126
+
127
+
Then you just add a line to every git commit message:
0 commit comments