@@ -26,6 +26,30 @@ Alternatively, if using OpenFermion-PySCF as a library, one can install the last
26
26
27
27
Also be sure to take a look at the ipython notebook demos in the examples folder of this repository.
28
28
29
+ How to contribute
30
+ -----------------
31
+
32
+ We'd love to accept your contributions and patches to OpenFermion-PySCF.
33
+ There are a few small guidelines you need to follow.
34
+ Contributions to OpenFermion-PySCF must be accompanied by a Contributor License Agreement.
35
+ You (or your employer) retain the copyright to your contribution,
36
+ this simply gives us permission to use and redistribute your contributions as part of the project.
37
+ Head over to https://cla.developers.google.com/
38
+ to see your current agreements on file or to sign a new one.
39
+
40
+ All submissions, including submissions by project members, require review.
41
+ We use GitHub pull requests for this purpose. Consult
42
+ `GitHub Help <https://help.github.com/articles/about-pull-requests/ >`__ for
43
+ more information on using pull requests.
44
+ Furthermore, please make sure your new code comes with extensive tests!
45
+ We use automatic testing to make sure all pull requests pass tests and do not
46
+ decrease overall test coverage by too much. Make sure you adhere to our style
47
+ guide. Just have a look at our code for clues. We mostly follow
48
+ `PEP 8 <https://www.python.org/dev/peps/pep-0008/ >`_ and use
49
+ the corresponding `linter <https://pypi.python.org/pypi/pep8 >`_ to check for it.
50
+ Code should always come with documentation, which is generated automatically and can be found
51
+ `here <http://openfermion.readthedocs.io/en/latest/openfermion.html >`_.
52
+
29
53
Authors
30
54
-------
31
55
0 commit comments