Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

72 lines (52 loc) · 3.22 KB

Contributing to CCMMF

The California Cropland Monitoring and Modeling Framework (CCMMF) is an integrated pipeline built on the SIPNET biogeochemistry model and PEcAn modeling, informatics, and statistical inference workflow engine.

This is a guide for contributors and users of the software.

How to contribute

We welcome contributions from the community to help improve and apply CCMMF including documentation, software, and data products.

Communication

Feel free to reach out directly with ideas, questions, and suggestions through our GitHub Discussions and join the #ccmmf channel in the PEcAn Project Slack.

Bug Reports and Feature Suggestions

If you find bugs or would like to request a feature, please open an issue in the appropriate GitHub repository and select the approprate bug report or feature request template.

For bugs, please provide a clear description of the bug and steps to reproduce it. If you find a bug or issue in R, please use the reprex package to generate a reproducible example.

To request a new feature, it will often be helpful to use Slack or GitHub Discussions to flesh out and brainstorm ideas. A good feature request will include a clear description of the feature and how it would be used.

Code of Conduct

This project has a Code of Conduct that provides a framework for a welcoming and collaborative environment. Contributors are expected to read and agree this code.

Code Contributions

We accept code contributions via Pull Requests (PRs) to GitHub repositories. GitHub provides excellent documentation of this process, e.g. Creating a Pull Request from a Fork.

All PRs must be reviewed by a member of the core CCMMF team and pass integration tests prior to being merged. The general PR workflow is:

  1. Identify an open issue, create a new feature request, or start a discussion.
  2. Fork the repository.
  3. Create a new branch.
  4. Make changes.
  5. Write tests.
  6. Update documentation.
  7. Push branch to your forked repository.
  8. Open a pull request to the 'develop' branch of the origin repository.
  9. Ensure tests pass.
  10. Address any questions or changes requested during review.

Once your contribution is merged it is time to elebrate!

Licenses and Copyright

Contributions to CCMMF will be released under permissive BSD 3-Clause (code), CC-BY (documentation). Contributions to PEcAn are released under BSD 3-Clause or compatible (UIUC NCSA) license.