Skip to content

Latest commit

 

History

History
executable file
·
45 lines (33 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
45 lines (33 loc) · 2.9 KB
Raw

Contributing

Thank you for your interest in contributing! We are grateful for your work.

Workflow

  1. If the work is nontrivial, please make sure there is an issue tracking it. This lets people know that you are interested in addressing this work and gives everyone a chance to weigh in on the appropriate solution.
  2. Fork this repository. There should be a current release candidate branch with a name like rc/X.Y.Z (there will be a pull request open for the most recent release candidate). You should do your work in a feature branch based on the current release candidate.
  3. When you are ready, open a pull request into the release candidate. Before doing so, please make sure that:
    • Any new code has new tests. The success of these tests implies that this code is working as intended.
    • All of the tests pass. You can check this by running pytest tests in your clone.
    • You have written documentation for all new code. This means docstrings at the very least. If you are implementing a substantial new feature, consider adding a long-form example notebook demonstrating its use.
    • Your code follows the Google Python style guide.
  4. Address any review comments. Once enough reviewers have approved your pull request, a maintainer will merge it.

Allen Institute Contribution Agreement

This document describes the terms under which you may make “Contributions” — which may include without limitation, software additions, revisions, bug fixes, configuration changes, documentation, or any other materials — to any of the projects owned or managed by the Allen Institute. If you have questions about these terms, please contact us at [email protected].

You certify that:

• Your Contributions are either:

  1. Created in whole or in part by you and you have the right to submit them under the designated license (described below); or

  2. Based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, under the designated license; or

  3. Provided directly to you by some other person who certified (1) or (2) and you have not modified them.

• You are granting your Contributions to the Allen Institute under the terms of the 2-Clause BSD license (the “designated license”).

• You understand and agree that the Allen Institute projects and your Contributions are public and that a record of the Contributions (including all metadata and personal information you submit with them) is maintained indefinitely and may be redistributed consistent with the Allen Institute’s mission and the 2-Clause BSD license.