Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. Don’t forget to read and adhere to the Contributor Covenant Code of Conduct.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/inpefess/gym-saturation/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.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement a fix for it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it. Contributors to the source code hold copyright of their work and should agree to distribute it under Apache 2.0 licence.

Write Documentation

gym-saturation could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such. Documentation authors hold copyright of their work and should agree to distribute it under Apache 2.0 licence.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/inpefess/gym-saturation/issues.

If you are proposing a new feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that contributions are welcome. Please refer to the Development Guide for details.