Skip to content

docs: update contributing guidelines - #138

Open
JPXKQX wants to merge 2 commits into
mainfrom
docs/scientific-validation
Open

docs: update contributing guidelines#138
JPXKQX wants to merge 2 commits into
mainfrom
docs/scientific-validation

Conversation

@JPXKQX

@JPXKQX JPXKQX commented Jun 18, 2026

Copy link
Copy Markdown
Member

Description

This PR updates the contributing guidelines with a new section about the scientific validation required for new features in Anemoi.

As a contributor to the Anemoi framework, please ensure that your changes include unit tests, updates to any affected dependencies and documentation, and have been tested in a parallel setting (i.e., with multiple GPUs). As a reviewer, you are also responsible for verifying these aspects and requesting changes if they are not adequately addressed. For guidelines about those please refer to https://anemoi.readthedocs.io/en/latest/

By opening this pull request, I affirm that all authors agree to the Contributor License Agreement.


📚 Documentation preview 📚: https://anemoi--138.org.readthedocs.build/en/138/

@github-project-automation github-project-automation Bot moved this to To be triaged in Anemoi-dev Jun 18, 2026
@JPXKQX JPXKQX self-assigned this Jun 18, 2026
@JPXKQX
JPXKQX requested a review from dnerini June 18, 2026 10:02
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 18, 2026
@JPXKQX
JPXKQX requested review from anaprietonem and frazane June 18, 2026 10:02
@JPXKQX
JPXKQX requested a review from mchantry June 18, 2026 13:28

@anaprietonem anaprietonem left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot Mario, to me the description for the label is clear and reads well!


- **Computational cost reduction** – Demonstrate that the feature
reduces training/inference time, faster convergence, memory usage, or
other resources.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
other resources.
other resources. Include profiling and benchmarking results comparing the implementation against a baseline run without the feature, using consistent hardware and settings.

@frazane frazane left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is reasonable, thanks for writing this down!

@mchantry

mchantry commented Jun 24, 2026

Copy link
Copy Markdown
Member

Thanks Mario, at ATS today we decided to tweak the proposal slightly.
The idea would be that any PR (irrespective of ATS label) can receive this new label, and that ATS may decide in special circumstances to waive this requirement.
I can update the PR if you are happy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ATS Approval Not Needed documentation Improvements or additions to documentation

Projects

Status: To be triaged

Development

Successfully merging this pull request may close these issues.

4 participants