Contributing

We warmly welcome community contributions to jaxKAN! Whether it’s reporting or fixing bugs, suggesting new features, or improving our documentation, your efforts are highly appreciated.

Below are some guidelines to help you get started with each type of contribution.

Reporting Bugs

  • Open an issue on GitHub with the [Bug] tag at the beginning of the title.

  • Provide a clear and descriptive title for the reported bug.

  • Include detailed information in the issue body to help others reproduce the bug. Useful details include, but are not limited to, OS and environment settings, the code that triggered the issue and comprehensive error logs.

  • If applicable, provide an example of expected behavior.

Solving Bugs

  • Fork the repository on GitHub and create a new branch, prefixed with bugfix-.

  • Implement your changes, ensuring the code is well-documented. New functions and classes must include docstrings that follow the Google Python style guide.

  • Add unit tests for your changes and ensure all tests (both new and existing) pass on your machine before submitting a Pull Request (PR).

Suggesting Features

  • Open an issue on GitHub with the [Feature] tag at the beginning of the title.

  • Provide a concise and descriptive title for the suggested feature.

  • Explain the problem the feature solves and/or the benefits it brings to the project.

  • If possible, share examples of how the feature might be used within the current codebase.

Documentation Updates

  • Fork the repository on GitHub and create a new branch, prefixed with docs-.

  • Update the documentation, ensuring consistency with the current version. All docstrings must adhere to the Google Python style guide.

  • Run the test suite on your machine to confirm all tests pass before submitting a Pull Request (PR).

Thank you for making jaxKAN better!