project-starter-templates

An example project featuring templates for key community health files. It provides structured templates serving as a guide for setting up a welcoming and organized project.

https://github.com/joseph-curtis/project-starter-templates

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
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.3%) to scientific vocabulary

Keywords

documentation example-project project-template-repo template-project
Last synced: 6 months ago · JSON representation ·

Repository

An example project featuring templates for key community health files. It provides structured templates serving as a guide for setting up a welcoming and organized project.

Basic Info
  • Host: GitHub
  • Owner: joseph-curtis
  • License: mpl-2.0
  • Default Branch: master
  • Homepage:
  • Size: 53.7 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
documentation example-project project-template-repo template-project
Created about 8 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Citation Security Support Governance

README.md

Hello-World

Welcome to the hello-world repository! This repository serves as an example project featuring templates for various community health files that are crucial for open-source projects. The goal of this repository is to provide a set of well-structured templates that can be used as a reference or starting point for other projects.

About This Repository

This repository includes templates for the following community health files:

  • README.md
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md
  • STANDARDS.md
  • LICENSE
  • CITATION.cff
  • .gitignore
  • CHANGELOG.md
  • GOVERNANCE.md
  • FUNDING.yml
  • SUPPORT.md
  • SECURITY.md
  • Discussion Category Form Templates (located under .github/DISCUSSION_TEMPLATE/)
  • Issue and Pull Request Templates (located under .github/ISSUE_TEMPLATE/)

Each of these files serves a specific purpose in fostering a healthy and welcoming community around a project. They provide clear guidelines for contribution, outline standards and practices, and offer essential information about the project's governance, support, and security policies.

Inspiration

The structure and content of the community health files in this repository were inspired by the guidelines provided by GitHub on setting up community health files for a project. You can find more information and guidance on this topic in the GitHub Docs: Creating a Default Community Health File.

Contributing

We welcome contributions to improve the templates and documentation in this repository. Please refer to our CONTRIBUTING.md file for detailed instructions on how you can contribute.

License

This project is licensed under the terms of the Mozilla Public License 2.0.

Acknowledgements

A special thank you to all contributors and maintainers of this project. Your efforts greatly enhance the open-source community.


For any additional information or questions, please feel free to open an issue in this repository.

Owner

  • Name: Joseph Curtis
  • Login: joseph-curtis
  • Kind: user
  • Location: Portland, OR

Currently a student of Computer Science Planning a career path around DevOps and backend/database software development

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: "hello-world"
message: >-
  "If you use this software, please cite it using the
  metadata from this file."
type: software
authors:
- family-names: "Curtis"
  given-names: "Joseph"
- family-names: "Curtis"
  given-names: "Joseph"
  email: "jcur175@wgu.edu"
  affiliation: "Western Governors University"
  orcid: "https://orcid.org/0000-0002-5445-9015"
repository-code: "https://github.com/joseph-curtis/hello-world"
abstract: >-
  "Research paper abstract or brief 
   description of project"
license: "MPL-2.0"
## doi: 10.5281/zenodo.1234
version: 1.0.0
date-released: '2024-01-28'

GitHub Events

Total
Last Year