Skip to content

Commit 8881d34

Browse files
committed
Added CONTRIBUTING.md
1 parent 7941560 commit 8881d34

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

CONTRIBUTING.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to JwtConnect-Python
2+
3+
All contributions to the Python JwtConnect packages are welcome!
4+
5+
Note that as this library is planned to be used in high-profile production code,
6+
we insist on a very high standards for the code and design, but don't feel shy:
7+
discuss your plans over
8+
[GitHub Issues](https://github.com/openid/JWTConnect-Python-OidcMsg/issues) and the
9+
[mailing list](http://lists.openid.net/mailman/listinfo/openid-specs-ab), and
10+
send in those pull requests!
11+
12+
# Signing the Agreements
13+
14+
In order to contribute to this project, you need to execute two legal agreements
15+
that cover your contributions. Pull requests from users who have not signed
16+
these agreements will not be merged.
17+
18+
## Execute the Contributor License Agreement (CLA)
19+
20+
1. Visit http://openid.net/contribution-license-agreement/
21+
2. Tap *Execute OpenID Foundation Contribution License Agreement* for the
22+
version relevant to you (Individual or Corporate).
23+
3. Follow the instructions to sign the agreement.
24+
25+
## Execute the Working Group Contribution Agreement
26+
27+
In addition to the Code License Agreement, the OpenID Foundation also requires
28+
a working group contribution agreement to cover any contributions you may make
29+
towards the OpenID Connect spec itself (e.g. in comments, bug reports, feature
30+
requests).
31+
32+
1. Visit http://openid.net/intellectual-property/
33+
2. Tap *Execute Contributor Agreement By Electronic Signature* in the box
34+
marked *Resources*.
35+
3. Follow the instructions to sign the document, state `OpenID AB/Connect` as
36+
the Initial Working Group.
37+
38+
# Making a Pull Request
39+
40+
## Before you Start
41+
42+
Before you work on a big new feature, get in touch to make sure that your work
43+
is inline with the direction of the project and get input on your architecture.
44+
You can file an [Issue](https://github.com/openid/JWTConnect-Python-OidcMsg/issues)
45+
discussing your proposal, or email the
46+
[list](http://lists.openid.net/mailman/listinfo/openid-specs-ab).
47+
48+
## Coding Standards
49+
50+
The JWTCOnnect-Python-OidcMsg library follows the
51+
[PEP8](https://www.python.org/dev/peps/pep-0008/)
52+
coding style for Python implementations. Please review your own code
53+
for adherence to the standard.
54+
55+
## Pull Request Reviews
56+
57+
All pull requests, even by members who have repository write access need to be
58+
reviewed and marked as "LGTM" before they will be merged.

0 commit comments

Comments
 (0)