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
+65-65Lines changed: 65 additions & 65 deletions
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,71 @@ Contributions are licensed on a license-in/license-out basis.
4
4
5
5
# Contributing Guide
6
6
7
+
## Communication
8
+
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.
9
+
A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior.
10
+
We will use the GitHub issue to discuss the feature and come to agreement.
11
+
This is to prevent your time being wasted, as well as ours.
12
+
The GitHub review process for major features is also important so that organizations with commit access can come to agreement on design.
13
+
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.
14
+
Specifically, if the goal is to add a new extension, please read the extension policy.
15
+
Small patches and bug fixes don't need prior communication.
16
+
17
+
## Coding Style
18
+
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.
19
+
20
+
## Sign your work
21
+
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):
22
+
23
+
```
24
+
Developer Certificate of Origin
25
+
Version 1.1
26
+
27
+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
28
+
1 Letterman Drive
29
+
Suite D4700
30
+
San Francisco, CA, 94129
31
+
32
+
Everyone is permitted to copy and distribute verbatim copies of this
33
+
license document, but changing it is not allowed.
34
+
35
+
36
+
Developer's Certificate of Origin 1.1
37
+
38
+
By making a contribution to this project, I certify that:
39
+
40
+
(a) The contribution was created in whole or in part by me and I
41
+
have the right to submit it under the open source license
42
+
indicated in the file; or
43
+
44
+
(b) The contribution is based upon previous work that, to the best
45
+
of my knowledge, is covered under an appropriate open source
46
+
license and I have the right under that license to submit that
47
+
work with modifications, whether created in whole or in part
48
+
by me, under the same open source license (unless I am
49
+
permitted to submit under a different license), as indicated
50
+
in the file; or
51
+
52
+
(c) The contribution was provided directly to me by some other
53
+
person who certified (a), (b) or (c) and I have not modified
54
+
it.
55
+
56
+
(d) I understand and agree that this project and the contribution
57
+
are public and that a record of the contribution (including all
58
+
personal information I submit with it, including my sign-off) is
59
+
maintained indefinitely and may be redistributed consistent with
60
+
this project or the open source license(s) involved.
61
+
```
62
+
63
+
Then you just add a line to every git commit message:
Use your real name (sorry, no pseudonyms or anonymous contributions.)
68
+
```
69
+
70
+
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with git commit -s.
71
+
7
72
## Set up your environment
8
73
9
74
This project uses [Poetry](https://python-poetry.org/) for dependency management, tests, and linting.
@@ -69,68 +134,3 @@ poetry run python3 -m black src --check
69
134
Remove the `--check` flag to write reformatted files to disk.
70
135
71
136
To simplify reviews you can format your changes in a separate commit.
72
-
73
-
## Communication
74
-
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.
75
-
A "major feature" is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior.
76
-
We will use the GitHub issue to discuss the feature and come to agreement.
77
-
This is to prevent your time being wasted, as well as ours.
78
-
The GitHub review process for major features is also important so that organizations with commit access can come to agreement on design.
79
-
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.
80
-
Specifically, if the goal is to add a new extension, please read the extension policy.
81
-
Small patches and bug fixes don't need prior communication.
82
-
83
-
## Coding Style
84
-
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.
85
-
86
-
## Sign your work
87
-
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):
88
-
89
-
```
90
-
Developer Certificate of Origin
91
-
Version 1.1
92
-
93
-
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
94
-
1 Letterman Drive
95
-
Suite D4700
96
-
San Francisco, CA, 94129
97
-
98
-
Everyone is permitted to copy and distribute verbatim copies of this
99
-
license document, but changing it is not allowed.
100
-
101
-
102
-
Developer's Certificate of Origin 1.1
103
-
104
-
By making a contribution to this project, I certify that:
105
-
106
-
(a) The contribution was created in whole or in part by me and I
107
-
have the right to submit it under the open source license
108
-
indicated in the file; or
109
-
110
-
(b) The contribution is based upon previous work that, to the best
111
-
of my knowledge, is covered under an appropriate open source
112
-
license and I have the right under that license to submit that
113
-
work with modifications, whether created in whole or in part
114
-
by me, under the same open source license (unless I am
115
-
permitted to submit under a different license), as indicated
116
-
in the file; or
117
-
118
-
(c) The contribution was provided directly to me by some other
119
-
person who certified (a), (b) or (c) and I have not modified
120
-
it.
121
-
122
-
(d) I understand and agree that this project and the contribution
123
-
are public and that a record of the contribution (including all
124
-
personal information I submit with it, including my sign-off) is
125
-
maintained indefinitely and may be redistributed consistent with
126
-
this project or the open source license(s) involved.
127
-
```
128
-
129
-
Then you just add a line to every git commit message:
0 commit comments