Contributing to mjinx

We're thrilled that you're interested in contributing to mjinx! This document outlines the process for contributing to this project.

How to Contribute

There are many ways to contribute to mjinx:

1. Reporting bugs
2. Suggesting enhancements
3. Writing documentation
4. Submitting code changes

Reporting Bugs

1. Check the issue tracker to see if the bug has already been reported.
2. If not, create a new issue. Provide a clear title and description, as much relevant information as possible, and a code sample or executable test case demonstrating the bug.

Suggesting Enhancements

1. Check the issue tracker to see if the enhancement has already been suggested.
2. If not, create a new issue. Clearly describe the enhancement, why it would be useful, and any potential drawbacks.

Writing Documentation

Good documentation is crucial. If you notice any part of our documentation that could be improved or expanded, please let us know or submit a pull request with your suggested changes.

Submitting Code Changes

1. Fork the repository.

2. Create a new branch for your changes.

3. Make your changes in your branch.

   Please, pay attention to the code style and mypy typing, it should match the one in the repository. The authors suggest to use pre-commit:

   pip3 install pre-commit
   pre-commit install
   

   This is included in one of the tests, and if you ignore it, the tests won't pass.

4. Add or update tests as necessary.

5. Ensure the test suite passes.

6. Update the documentation as needed.

7. Push your branch and submit a pull request.

Pull Request Process

1. Ensure your code follows the project's style guidelines.
2. Update the README.md or relevant documentation with details of changes, if applicable.
3. Add tests for your changes and ensure all tests pass.
4. Your pull request will be reviewed by the maintainers. They may suggest changes or improvements.
5. Once approved, your pull request will be merged.