Add CITATION.cff advice #148
Merged
Conversation
This file contains 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
CITATION.cff is now the standard for software projects to give their citation information in human and machine readable formats. Added to the document. General Markdown lint was applied as well, using the markdownlint plugin for VS Code.
We should really take the title from the YAML frontmatter, but that doesn't seem to work with our current processing options.
|
Hello @graeme-a-stewart, @hegner, I'm coming late to the party but since you mentioned earlier today at the coords meeting that you would welcome feedback - recently the developer guide in the Scikit-HEP website was moved "up" to Scientific Python; it is now far more visible and useful to a broader community. You can see the end result at https://learn.scientific-python.org/development/. Maybe that's something useful to add to here even if many things are specific for Python? BTW, one brilliant tools is the "repository review" https://learn.scientific-python.org/development/guides/repo-review/. Just paste a repo URL and see it running even on the browser :-). HTH. |
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.
Add a recommendation to use the
CITATION.cffformat for advertising how to cite software - it's the standard way to do it these days!