enhance X-schema.org-keywords in DESCRIPTION files
Description
This pull request adds X-schema.org-keywords to the DESCRIPTION files across various packages to enhance metadata and improve discoverability. The most important changes include the addition of keywords related to PEcAn functionalities and scientific concepts.
Motivation and Context
fixes #3060 and #2946
Review Time Estimate
- [ ] Immediately
- [ ] Within one week
- [ ] When possible
Types of changes
- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
- [ ] My change requires a change to the documentation.
- [ ] My name is in the list of CITATION.cff
- [x] I agree that PEcAn Project may distribute my contribution under any or all of
- the same license as the existing code,
- and/or the BSD 3-clause license.
- [ ] I have updated the CHANGELOG.md.
- [ ] I have updated the documentation accordingly.
- [x] I have read the CONTRIBUTING document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
Thanks @AritraDey-Dev , this is a great start but there are also packages in the modules and models folders that we should update. Then we should have a few people on the core team review the tags.
What was your approach to tag number and naming? Are there any particular guidelines or best practices we should consider?
modules and models folders that we should update.
Thanks @dlebauer for clarifying this.I will add the keywords for models and modules in the new commits soon.
What was your approach to tag number and naming?
I tried to select keywords based on each package’s functionality and scientific scope, but since this touches many core packages, the PR could benefit from a thorough review.
Are there any particular guidelines or best practices we should consider?
I believe it should aim for concise, relevant keywords that reflect each package’s core purpose. do you have any specific thoughts or preferences on the approach to adding them?
@dlebauer The PR is now ready for review. I’ve added relevant X-schema.org-keywords keywords to all the DESCRIPTION files .
Please take a look at the changes at your convenience and let me know your thoughts or suggestions for improvement.
@infotroph Thanks for taking time and giving the suggestion for the keywords.
Following your comment regarding the keywords model packages, I have kept only the model name and ecosystem-modeling as the keywords for the model description files.