gh-best-practices-template
Template with best practices for building sustainable GitHub repositories
Science Score: 39.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
Found 2 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.5%) to scientific vocabulary
Keywords
Repository
Template with best practices for building sustainable GitHub repositories
Basic Info
Statistics
- Stars: 26
- Watchers: 2
- Forks: 5
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
GitHub Best Practices Template
This is a template repository for helping others to follow the best practices when developing GitHub projects.
You will find a collection of files and configuration recommendations for kick-starting a new project in GitHub.
You can start by following the instructions at the guidelines file.
Using this template for your project
To use this template, you can create a new repository by clicking on Use this template button.
The new repository will use this one as a template, meaning that it will contain all the files. Once the new repository is created, you can edit its files to adapt them to your needs.
Guidelines & Contributing
You will find a guided description of the steps you should follow in the guidelines file.
Please, read carefully the guidelines and adapt them to your needs.
If you find any issue or have any suggestion, please, feel free to open an issue. Just remember that:
Anyone participating will be subject to and agrees to sign on to the Code of Conduct.
The development and community management of this project follows the governance rules described in the GOVERNANCE.md document.
References
During the development of this template, I have been working with the following resources: * Recommended Practices for Hosting and Managing Open Source Projects on GitHub * The role of foundations in open source projects * Contributor Covenant * Mozillas code of conduct enforcement ladder * SustainOSS Code of Conduct * CommunityRule * Minimum Viable Governance
License
This work is licensed under a Creative Commons Attribution 4.0 International License
The CC BY license allows reusers to distribute, remix, adapt, and build upon the material in any medium or format, so long as attribution is given to the creator. The license allows for commercial use.
Owner
- Name: Javier Canovas
- Login: jlcanovas
- Kind: user
- Location: Barcelona
- Website: http://jlcanovas.es
- Twitter: jlcanovas
- Repositories: 31
- Profile: https://github.com/jlcanovas
Associate Professor and Researcher at UOC - IN3. I love language engineering, Web APIs, Models and Collaboration
GitHub Events
Total
- Watch event: 5
Last Year
- Watch event: 5