Contributing

Welcome Contributors!

We welcome contributions to improve the MPAS CPTP decadal documentation and analysis tools.

How to Contribute

Documentation

To contribute to the documentation: 1. Fork the repository 2. Create a new branch for your changes 3. Make your edits to the Markdown files 4. Submit a pull request

Code Contributions

To contribute code (analysis scripts, tools, etc.): 1. Fork the repository 2. Create a new branch 3. Add your code with appropriate documentation 4. Include tests if applicable 5. Submit a pull request

Contribution Guidelines

Documentation Style

  • Use clear, concise language
  • Include examples where appropriate
  • Follow Markdown best practices
  • Link to related pages

Code Style

  • Follow PEP 8 for Python code
  • Include docstrings
  • Add comments for complex logic
  • Write unit tests

Commit Messages

  • Use clear, descriptive commit messages
  • Reference issues when applicable
  • Keep commits focused and atomic

Review Process

  1. Submit your pull request
  2. Automated checks will run
  3. Maintainers will review your contribution
  4. Address any feedback
  5. Your contribution will be merged

Code of Conduct

Please be respectful and professional in all interactions. We are committed to providing a welcoming and inclusive environment for all contributors.

Questions?

If you have questions about contributing: - Check existing documentation - Review closed issues and pull requests - Open a new issue for discussion - Contact the maintainers

License

By contributing, you agree that your contributions will be licensed under the same license as the project.