Contributing#

All contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Ways to contribute#

There are many ways to contribute to the ValEnsPy package:

Partake in one of the discussions or create a new one.
Create a new issue to help us improve the package.
Contribute to the codebase.
Help improve the documentation.

Partake in discussions#

Give your opinion in an existing discussion or create a new one. This is a great way to share your ideas and help us improve the package. Discussion highlight - Choosing a name for the package.

Create a new issue#

Create a new issue helps us fix bugs, add new features, and improve the package. Make use of the issue templates and labels to help us understand your issue better.

Contribute to the codebase#

To contribute first follow the installation guidelines.

You can then contribute to the codebase by:

Taking on an open issue
Creating a new diagnostic: see example

Create a new branch, a new pull request and link it to the issue(s) you are working on. Read the developer guidelines in the Contributing section of the documentation for more information on how your code will be integrated into the package.

Help improve the documentation#

The docementation helps others help themselves and in turn help contribute to the package. You can help improve the documentation by:

Adding a new example notebooks
Improving the general documentation
Reporting gaps in the documentation in an issue
Document your code while you are developing it

For additional developer guidelines see the Notes for developers page in the Contributing section of the documentation.