Skip to content

Contributing to [Project Name]

Thank you for your interest in contributing to this MBARI project! We welcome contributions from the scientific and engineering community.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with: - A clear description of the problem - Steps to reproduce - Expected vs. actual behavior - Your environment (OS, software versions, etc.)

Suggesting Enhancements

We welcome suggestions! Please open an issue describing: - The enhancement you'd like to see - Why it would be useful - Any implementation ideas you have

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add tests if applicable
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to your branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Code Style

  • Follow existing code style and conventions
  • Include comments for complex logic
  • Add docstrings for functions and classes
  • Keep commits focused and atomic

Testing

  • Add tests for new features
  • Ensure all tests pass before submitting
  • Run the test suite: [test command]

Licensing

By contributing to this project, you agree that your contributions will be licensed under the same license as the project (see LICENSE).

Specifically: - You certify that you have the right to submit the code - You agree to the Developer Certificate of Origin - Your contributions will be licensed under the [License Name] license

Developer Certificate of Origin

By making a contribution to this project, you certify that:

  • The contribution was created in whole or in part by you and you have the right to submit it under the open source license indicated in the file; or
  • The contribution is based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, under the same open source license; or
  • The contribution was provided directly to you by some other person who certified (1) or (2) and you have not modified it.

Code of Conduct

Our Pledge

We are committed to providing a welcoming and inclusive environment for all contributors, regardless of background or identity.

Standards

  • Be respectful and professional
  • Welcome diverse perspectives
  • Focus on constructive criticism
  • Support other contributors

Enforcement

Violations of the code of conduct can be reported to [contact email]. All complaints will be reviewed and investigated.

Questions?

If you have questions about contributing, please: - Check existing issues and discussions - Contact the project maintainers - Email: [maintainer email]

Recognition

Contributors will be acknowledged in the project documentation and release notes.

Additional Resources

Thank you for contributing to ocean science and technology!