Conversation
Contributor
|
📄 Documentation for this branch is available at: https://ncar.github.io/musica/branch/contributors/ |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #385 +/- ##
=======================================
Coverage 87.09% 87.09%
=======================================
Files 43 43
Lines 3860 3860
=======================================
Hits 3362 3362
Misses 498 498 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
K20shores
requested review from
boulderdaze,
Copilot,
mattldawson and
sjsprecious
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances project metadata and community guidance by adding dedicated contributor and author information, updating citation handling, and integrating Zenodo metadata.
- Introduces
CONTRIBUTING.mdwith guidelines and recognition policy. - Adds
AUTHORS.mdlisting core team and contributors. - Updates
README.mdwith links to the new guides and restructures the citation section. - Adds
.zenodo.jsonto control publication metadata and contributor types.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Updated installation, added Mechanism Configuration link, and restructured Contributing and Citations sections. |
| CONTRIBUTING.md | Created contributor guide with setup instructions, contribution types, and recognition policy. |
| AUTHORS.md | Added author and contributor listing with citation references. |
| .zenodo.json | Defined metadata for creators and contributors to customize Zenodo entries. |
Comments suppressed due to low confidence (2)
AUTHORS.md:19
- The referenced 'CITATION.cff' file is not included in this PR. Either add the file or update the reference to point to the correct citation source.
please refer to our [CITATION.cff](CITATION.cff) file. To cite the software, use the Zenodo DOI from our latest release.
.zenodo.json:52
- Contributor 'Ward Fisher' is listed here but not included in AUTHORS.md; consider aligning the additional contributors in AUTHORS.md with those in '.zenodo.json'.
"name": "Ward Fisher",
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
mattldawson
approved these changes
Jun 25, 2025
Collaborator
mattldawson
left a comment
mattldawson
left a comment
There was a problem hiding this comment.
I like it! Just one suggestion, but I think it's fine to merge
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This creates a dedicated Contributors guide, a page for authors, and adds a
.zenodo.jsonwhich allows us to more explicitly control how we appear on zenodo. Additionally, I learned that we can specify contributor types in the zenodo file. These types are listed here.