Contributing to the LT Toolbox#

Thank you for your interest in contributing to LT Toolbox! We welcome contributions from the community to help improve Lagrangian ocean analysis.

Getting Started#

To get started with contributing to LT Toolbox, please follow these steps:

  1. Fork the lt_toolbox 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.

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

  • Follow the PEP 8 <https://peps.python.org/pep-0008/>`_ style guide when writing code.

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

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

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

  2. Push your changes to your forked repository.

  3. Submit a pull request to the main branch of the lt_toolbox.

Code Guidelines#

When contributing code to LT Toolbox, 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 encounter any bugs or have ideas for new features, please open an issue on the LT Toolbox 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 LT Toolbox 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 improve LT Toolbox!