Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 1.87 KB
Raw

Contributing to Tensor-Networks-Simple-Update

We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from dev (not main).
  2. Install locally using requirements.txt.
  3. If you've added code that should be tested, add tests to tests/test_main.py.
  4. If you've changed APIs, update the documentation.
  5. Ensure the test suite passes by install and run pytest.
  6. You are encouraged to use pre-commit with pip install pre-commit and then pre-commit install.
  7. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

License

By contributing, you agree that your contributions will be licensed under its MIT License.