Skip to content

Contributing

Summary

This page provides guidance for contributors to the ValidOcean package.

Contributing to ValidOcean

Thank you for your interest in contributing to ValidOcean!

We welcome contributions from the community to help improve the validation of ocean general circulation models.

Getting Started

To get started with contributing to ValidOcean, please follow the steps below:

  1. Fork the ValidOcean repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution.

  4. Make your changes and improvements to the codebase.

  5. Follow the NumPy docstring conventions when adding or modifying docstrings.

  6. Follow the PEP 8 style guide when writing code.

  7. Test your changes thoroughly to ensure they work as expected.

  8. Unit tests should be added using pytest for any new features.

  9. Commit your changes with clear and descriptive commit messages.

  10. Push your changes to your forked repository.
  11. Submit a pull request to the main branch of ValidOcean.

Code Guidelines

When contributing code to ValidOcean, please adhere to the following guidelines:

  • Follow the coding style and conventions used in the existing codebase.
  • Write clear and concise code with appropriate comments.
  • Ensure your code is well-tested and does not introduce any regressions.
  • Document any new features or changes in the appropriate sections of the documentation.

Bug Reports and Feature Requests

If you find any bugs or have ideas for new features, please open an issue on the ValidOcean GitHub repository.

Provide as much detail as possible, including steps to reproduce the issue or a clear description of the desired feature.

Community Guidelines

When participating in the ValidOcean community, please be respectful and considerate towards others. Follow the code of conduct and engage in constructive discussions.

We appreciate your contributions and look forward to working with you to grow & improve ValidOcean!