CONTRIBUTING.rst

Contributing to CAP

Thank you for your interest in contributing to the Community Analysis Pipeline (CAP)! We welcome contributions from the Mars climate modeling community.

Getting Started

1. Fork the repository on GitHub

2. Clone your fork locally:

   git clone git@github.com:your-username/AmesCAP.git
   cd AmesCAP
   

3. Create a branch for your work:

   git checkout -b name-of-your-feature
   

Code Style

• Follow PEP 8 Python style guidelines outlined here
• Use meaningful variable names
• Include docstrings for functions and modules
• Add comments for complex algorithms
• Keep functions focused and single-purpose

Documentation

When adding new features, please include:

• Docstrings that explain parameters and return values
• Example usage in the docs
• Updates to relevant tutorial materials if needed

Testing

• Test your changes thoroughly before submitting
• Ensure changes don't break existing functionality
• Add example files if adding new capabilities
• Test on both Legacy GCM and NASA Ames GCM outputs

Submitting Changes

1. Commit your changes:

   git add .
   git commit -m "Brief description of your changes"
   

2. Push to your fork:

   git push origin name-of-your-feature
   

3. Open a Pull Request on GitHub

   • Provide a clear description of the changes
   • Mention any issues this addresses
   • Include example outputs if relevant

Review Process

• A maintainer will review your pull request
• We may suggest changes or improvements
• Once approved, we'll merge your contribution

Getting Help

• Open an issue for bugs or feature requests
• Ask questions in pull requests
• Contact the maintainers directly for guidance

Code of Conduct

• Be respectful of other contributors
• Welcome newcomers
• Focus on constructive feedback
• Maintain professional communication

Thank you for helping improve CAP!