deposit-examplehal_swh
Projet test et modèle - sert uniquement à la formation au dépôt dans Hal en lien avec Software Heritage
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.1%) to scientific vocabulary
Keywords
Repository
Projet test et modèle - sert uniquement à la formation au dépôt dans Hal en lien avec Software Heritage
Basic Info
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
deposit-exampleHal_SWH
new version
Repository template for archival
Name your project or package, because the repository name isn't enough.
Badges
put DOI badge if exists
put SWH badge
There are many services providing badges that can be helpful.
Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with.
Background
Some background can always help.
Features
A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
Installation
To help the reader install, compile and reuse your code, descrivbe the environment needed for your code.
Requirements
Link to the file containing this information or directly inform your visitor of the dependencies needed.
Usage
How to use your software after it is installed. It can be helpful to explicitly write the commands and options that are possible with your code. Links to the documentation or online tutorials are a good bonus.
Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Roadmap
This is a great bonus section, but might be harder to maintain. If you have ideas for releases in the future, it is a good idea to list them in the README.
Contributing
State if you are open to contributions and what your requirements are for accepting them.
Tests
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Authors and acknowledgment
This section can also state the authors are in a seperate file. Refer to AUTHORS and/or CONTRIBUTORS file/s.
See also
Links to other projects or publications, links to datasets.
License
Refer to LICENSE file or folder for further information
references:
- https://www.makeareadme.com/
Owner
- Login: JSadowska
- Kind: user
- Repositories: 1
- Profile: https://github.com/JSadowska
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"type": "SoftwareSourceCode",
"applicationCategory": "Computer Science",
"author": [
{
"id": "_:author_1",
"type": "Person",
"email": "peter.pan@wonderland.org",
"familyName": "Pan",
"givenName": "Peter"
},
{
"id": "_:author_2",
"type": "Person",
"email": "c.hook@wonderland.org",
"familyName": "Hook",
"givenName": "Captain"
},
{
"id": "_:author_3",
"type": "Person",
"email": "w.darling@wonderland.org",
"familyName": "Darling",
"givenName": "Wendy"
}
],
"codeRepository": "https://github.com/JSadowska/deposit-exampleHal_SWH",
"dateCreated": "2024-06-06",
"description": "Software for the wonderland team",
"keywords": [
"software",
"wonderland",
"fantasy"
],
"license": "https://spdx.org/licenses/AGPL-3.0",
"name": "The wonderland app",
"operatingSystem": "Linux",
"programmingLanguage": "Python",
"runtimePlatform": "Runtime Platform",
"version": "1.0.0"
}GitHub Events
Total
- Push event: 2
Last Year
- Push event: 2