Skip to content

Contributing¤

Contributions of any kind are welcome and appreciated. See the guidelines below.

Expectations¤

Jim is developed and maintained by the GW JAX Team and community contributors. While we try to be responsive, we don’t always get to every issue immediately. If it has been more than a week or two, feel free to ping the maintainers on the issue.

Did you find a bug?¤

Ensure the bug was not already reported by searching on GitHub under Issues. If you’re unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and the simplest possible code sample demonstrating the expected behaviour that is not occurring.

Did you write a patch that fixes a bug?¤

Open a new GitHub pull request with the patch. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

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

Open a new GitHub pull request with the feature or change. Please follow these principles:

  1. New features should be JAX-compatible.
  2. Lightweight and modular implementation is preferred.
  3. Jim is a gravitational-wave inference toolkit. Waveform models belong in ripple, and sampling algorithms belong in the respective sampler package.

If you are unsure whether a feature fits, open an issue first to discuss it with the maintainers.

Do you intend to add an example or tutorial?¤

Open a new GitHub pull request with the example or tutorial. The example should be self-contained and keep imports from other packages to a minimum. Leave case-specific analysis details out.