Add guide on citing software #32
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
bourque
approved these changes
Sep 20, 2024
| good example of this second approach, which follows guidance from the [Turing Way](https://the-turing-way.netlify.app/communication/aa/aa-equitable) | ||
| project. | ||
|
|
||
| Credit: Content taken from a Confluence guide written by Veronica Martinez |
There was a problem hiding this comment.
I have been adding an "Acronyms" section at the bottom of pages that spell out any acronyms used within the document. There are a few here that I think could be mentioned: DOI, SMD, and API.
There was a problem hiding this comment.
I like what you did for the docker guides. I'll add a section on acronyms here!
| * There are multiple ways to cite authors for software. One method is to list the name of each contributor. | ||
| Since the list of contributors may change from release to release, a contributors list in the repository | ||
| can help track these updates and ensure proper attribution. Another option is to list a group or organization | ||
| as the author (i.e. <project name> Developers) and recognize individual contributors via the all-contributors bot. |
There was a problem hiding this comment.
Suggested change
| as the author (i.e. <project name> Developers) and recognize individual contributors via the all-contributors bot. | |
| as the author (i.e. `<project name>` Developers) and recognize individual contributors via the all-contributors bot. |
This might be needed. Without it, I think markdown is treating it in some strange way (I see that it doesn't show up in the RtD page)
Co-authored-by: Matthew Bourque <[email protected]>
Co-authored-by: Matthew Bourque <[email protected]>
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 guide covers content from this confluence page that I created a few months back. It only covers using Zenodo. Any other methods for citing software will need to be added.