Repository Documentation Overhaul and FAIR Compliance Improvements #6
Conversation
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
1 participant
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.
Dear Maintainers,
This pull request introduces several updates to improve the repository's documentation and compliance with FAIR principles. Below are the details of the changes made:
README Updates:
Added sections for features, installation instructions, usage guide, and acknowledgments.
Improved clarity by linking to external files where applicable.
CONTRIBUTING.md:
Added a new CONTRIBUTING.md file to provide detailed guidelines on how to contribute to the project.
CITATION.cff:
Added a CITATION.cff file to make the repository citable in research, with metadata including authorship, versioning, and licensing.
These changes aim to:
Enhance accessibility for contributors and users.
Provide clear guidance for participation.
Improve compliance with FAIR principles (Findable, Accessible, Interoperable, Reusable).
Please let me know if there are any additional adjustments or improvements required. I look forward to your feedback!
Best regards,
Saad Abdullah