Contributing

We really thank you for the input! We are welcome to most of feedbacks such as

  • Reporting a bug

  • Discussing the current state of the code

  • Submitting a fix

  • Proposing new features

  • Becoming a maintainer

Report bugs

We use GitHub issues (https://github.com/lys-devel/lys/issues) to track public bugs. Report a bug by opening a new issue, which includes

  • A quick summary and/or background

  • Steps to reproduce

  • 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)

Pull requests

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

  1. Fork the repo and create your branch from main.

  2. Make sure your code follows pep8 (We recommend to use autopep8).

  3. If you’ve added code that should be tested, add tests.

  4. Ensure the Automated test passes.

  5. If you’ve changed APIs, update the documentation. We use sphinx and reStructuredText for documentation.

  6. Issue that pull request in GitHub.

Automated test

See Automated test for automated test.

License

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