Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 1.49 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! The general contribution process is outlined below.

Report Bugs

Report bugs using GitHub issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Implement your changes and feedback

The project could always be improved e.g. through fixes to typographical and grammatical errors. Readers might want to contribute additional numerical examples to better highlight the concepts presented here.

Submit Feedback

The best way to offer feedback is to file an issue on GitHub.

For instance, if you are proposing a new acceleration framework for python codes:

  • Explain in detail how it works, providing links to official documentation of upstream projects.
  • Keep the scope as narrow as possible, to make it easier to implement.

Get Started

Ready to contribute? Here's a step-by-step procedure of the general procedure.

  1. Fork the repo on GitHub.
  2. Clone your fork locally.
  3. Install your local copy into a virtualenv, e.g., using conda.
  4. Create a branch for local development and make changes locally.
  5. Commit your changes and push your branch to GitHub.
  6. Submit a pull request through the GitHub website.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By contributing, you agree to abide by its terms.