Contributing

Thank you for your interest to developping additional contributions for the ocean4dvarnet package.

---

Contributing to the development

For contributing to the development of ocean4dvarnet-contrib, please follow these steps:

• Fork the ocean4dvarnet-contrib repository on GitHub to your personal/organisation account. See the GitHub tutorial : https://docs.github.com/en/get-started/quickstart/fork-a-repo.
• Set up the development environment following the instructions in the documentations :
  • Setting up a CUDA + PyTorch environment wtih Mamba
  • Setting up the development environment
• Create a new branch for your developments, following the ocean4dvarnet branching-guidelines
• Make your changes and ensure that your changes adhere to the ocean4dvarnet contributing-guidelines
  • To contribute to an existing contribution, make your change in the contribution code
  • To add e new contribution, follow the guide Creating a New Contribution
• Commit your changes and push your branch to your fork on GitHub.
• Open a Pull Request against the main branch of the original repository, set a PR title according to the ocean4dvarnet Commit and PR Message Guidelines and fill in the Pull Request template.
• Request a review from maintainers or other contributors, which will follow the code-review-process.

rem : you can find some usefull scripts and tools in the script directory of the repository.

---

Code Review Process

The ocean4dvarnet-contrib packages have a set of automated checks to enforce coding guidelines. These checks are run via GitHub Actions on every Pull Request.

For security reasons, maintainers must review code changes before enabling automated checks.

• Ensure that all the ocean4dvarnet contributing-guidelines criteria are met before submitting a Pull Request.
• Request a review from maintainers or other contributors, noting that support is on a best-efforts basis.
• After an initial review, a maintainer will enable automated checks to run on the Pull Request.
• Reviewers may provide feedback or request changes to your contribution.
• Once approved, a maintainer will merge your Pull Request into the appropriate branch.

---

Code of conduct

Please follow the GitHub Code of Conduct for respectful collaboration.