software_release_demo
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: douglowe
- License: mit
- Default Branch: main
- Size: 759 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 1
Metadata Files
README.md
Software Release
Before releasing software for general there are a number of common actions needed to ensure that others know how to: - to use your code - which version they are using - how to access your code - how to cite your work
Document Code Use: Licensing
Most developers know that they need to document the technical details of how to use their code. But many forget that they also need to document the social details of how their code can be used. To establish this social contract you must release your code under a license. This license will guide others on what they can, and cannot, do with your code. Without the certainty on usage that a license provides, many users won't touch your code. Usually we will wish to use an Open Source license - so that our code is a widely useable as possible. However there are a number of different open source licenses available, and your choice of which to use will determine how free end users are to modify, use, and share your code. For details on these licenses visit Choose a License.
Github enables the fast addition of a license to a repository. To make use of this,
first you need to click the Add file option on the repository, and select Create new file.
This takes you to the interface for creating new files. Enter the filename License (or License.md,
License.txt, etc, as you wish). At this point a Choose a license template option will appear, which
you should click.
This takes you to an interface for choosing which license you want. Select one from the left of the page,
following the guide on the Choose a License website for which you want.
After selecting your desired license, fill in the details for the license in the panel on the right, then
click the Review and submit button.
This takes you to a preview of the license file. Check this to ensure the details are correct, then click
the Commit changes button, enter a commit message (e.g.: 'add license file'), and commit your changes.
Once these is done your code will be properly licensed, and you will be ready to go onto the next stage in releasing it.
Versioning of your Code
add versioning guide here
Sharing your Code
Archiving
Zenodo instructions here
Releasing
pip and conda packaging?
Provide Citation for your Code
End users of your code may wish to reference it in their publications. To help them with this,
and to make sure that references to your work are consistent, you can add a CITATION.cff file
to your repository. This plain-text file provides others with information on how you want them
to cite your work. Github will also parse this file to provide users with an interface on
your repository to access the citation information.
add instructions here
You can get more information on these files from Rob Haines' blog post and from the Github documentation page.
Owner
- Name: Douglas Lowe
- Login: douglowe
- Kind: user
- Location: Manchester, UK
- Company: University of Manchester
- Repositories: 83
- Profile: https://github.com/douglowe
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Lowe" given-names: "Douglas" orcid: "https://orcid.org/0000-0002-1248-3594" title: "Software_Release_Demo" version: 0.9.0 doi: 10.5281/zenodo.10160063 date-released: 2023-11-20 url: "https://github.com/douglowe/Software_Release_Demo"
GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0