Thank you for considering contributing to the development of FATES. There are a few guidelines that we need contributions to follow.
https://github.com/NGEET/fates/blob/master/LICENSE.txt
https://github.com/NGEET/fates/blob/master/CODE_OF_CONDUCT.md
Those who wish to contribute code to FATES must have those changes integrated through the developer repository NGEET/fates. Changes that make it to public releases must go through this repository first, as well. Please refer to the developer section of the User's Guide for more details. Here are some basic first steps:
- All developers should create a fork of the NGEET/fates repository into their personal space on github
- Follow the developer work-flow
- Each set of changes should have its own feature branch that encapsulates your desired changes.
- The work-flow will lead you eventually to submit a Pull-Request to NGEET/fates:master, please follow the template in the Pull Request and communicate as best you can if you are unsure how to fill out the text
- It is best to create an issue to describe the work you are undertaking prior to starting. This helps the community sync with your efforts, prevents duplication of efforts, and science is not done in a vaccuum!
- Expect peers to interact, help, discuss and eventually approve your submission (pull-request)
AI agents should not be used to submit pull requests, issues, discussion items or other features available on the developer platforms on which the FATES model is officially hosted (i.e. Github), except on a case-by-case basis. Approval to do so should be sought from a core member of the FATES development team. Unapproved submissions will be closed. Repeated unapproved submissions may culminate in the blocking of the submitting user.
Contributors that use generative AI to help develop code are asked to describe its usage when submitting a pull request. Specifically, we request information such as the platform use and the extent of its use in producing the pull request (for example, specific commands versus chunks of code written with generative AI).
In addition to the github discussions, we hold a roughly biweekly call, which covers both scientific and technical issues related to FATES. We use a google group to organize, schedule, and discuss these calls. Emails to the list are moderated and we try to be pretty ruthless about preventing anything other than this topic from appearing on it. To join, apply to the group here: https://groups.google.com/forum/#!forum/fates_model
- Make commits in logical units (i.e. group changes)
- Changes that are submitted should be limited to 1 single feature (i.e. don't submit changes to the radiation code and the nutrient cycle simultaneous, pick one thing)
- Check for unnecessary whitespace with
git diff --checkbefore committing - We have no standard protocol for commit messages, but try to make them meaningful, concise and succinct.
- You will most likely have to test (see workflow above), see the testing protocols for more details.
Please refer to the FATES style guide
If changes are trivial, it's possible testing will not be required. Conversations via the Pull Request will address if tests are not needed
Yes please! If you are creating new code, fixing existing code, anything. Please add comments in the code itself. Please also follow the style guide for comments. Please update the tech note, and submit a PR to the fates-docs repo alongside your FATES PR. Also, please create and/or modify existing wiki documentation. You may be asked to add documtation prior to having a pull-request approved.