Contributing to BOUT Runners

Thank you for wanting to contribute to BOUT Runners

Did you find a bug?

  1. Ensure the bug was not already reported by searching on GitHub as a bug report.

  2. If you’re unable to find an open issue addressing the problem, open a new one.

Did you write a patch that fixes a bug?

  1. Open a new GitHub pull request with the patch.

  2. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  3. Before submitting, please ensure that all pre-commit tests are passing by running pre-commit run --all-files

Do you intend to add a new feature or change an existing one?

  1. Suggest your change as a feature request and start writing code.

  2. Make a pull request which links to the feature request mentioned above.

Do you have questions about the source code?

  1. Ask any question about how to use BOUT Runners in help wanted.

Thanks for helping out!