Skip to content

Latest commit

 

History

History
22 lines (12 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

22 lines (12 loc) · 1.49 KB

Contributing to Acorns

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Acorns and its packages, which are hosted in the Repo on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Examples

Please write C++ examples for new code you create in this directory and then include the call to the forward and reverse single and double differentiation in this file.

Submitting changes

Please send a GitHub Pull Request to acorns with a clear list of what you've done (read more about pull requests). When you send a pull request, we will highly appreciate it if you include examples in the examples/ directory as described above. We can always use more example coverage. Please make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Thank you!!