Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

40 lines (33 loc) · 2.06 KB
Raw

How to contribute

We welcome contributions from external contributors, and this document describes how to merge code changes into this repository.

Getting Started

  • Make sure you have a GitHub account.
  • Fork this repository on GitHub.
  • On your local machine, clone your fork of the repository.

Making Changes

  • Add some really awesome code to your local fork. It's usually a good idea to make changes on a branch with the branch name relating to the feature you are going to add.
  • When you are ready for others to examine and comment on your new feature, navigate to your fork of chemprop on GitHub and open a pull request (PR). Note that after you launch a PR from one of your fork's branches, all subsequent commits to that branch will be added to the open pull request automatically. Each commit added to the PR will be validated for mergability, compilation and test suite compliance; the results of these tests will be visible on the PR page.
  • If you're providing a new feature, you must add test cases and documentation.
  • When the code is ready to go, run the test suite: pytest.
  • When you're ready to be considered for merging, click the "Ready for review" box on the PR page to let the Chemprop devs know that the changes are complete. The code will not be merged until the continuous integration returns checkmarks, and at least one core developer gives "Approved" reviews.

Additional Resources