oss-documents

Collecting guidance, documents, examples, templates for open-source software project, such as on governance, roadmaps, contributing, license, code of conduct

https://github.com/corsa-center/oss-documents

Science Score: 54.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
Links to: ieee.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (8.5%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Collecting guidance, documents, examples, templates for open-source software project, such as on governance, roadmaps, contributing, license, code of conduct

Basic Info

Host: GitHub
Owner: corsa-center
License: cc-by-4.0
Default Branch: main
Homepage:
Size: 70.3 KB

Statistics

Stars: 54
Watchers: 9
Forks: 13
Open Issues: 0
Releases: 0

Created about 2 years ago · Last pushed 10 months ago

Metadata Files

Readme License Citation Authors

Open-source software project documents

This repository is intended to collect guidance, documents, examples, templates for open-source software projects, such as on governance, roadmaps, contributing, code of conduct, licenses, etc. It was started as part of the DOE-funded CORSA project.

Documents and links

General guidance

Roadmaps

The Turing Way guidance on roadmapping
Examples
- SymPy: https://www.sympy.org/en/roadmap.html

Licenses

GitHub's Choose an open source license
Open Seed's A Primer on Open Licenses, by Yo Yehudi
CNCF Recommendations for Attribution Notices
Software Sustainablity Institute's Choosing an open source license
OSS Licensing for Research and Education - a short course that introduces researchers (doctoral students, postdocs, staff researchers and PIs) to the essentials of open-source software (OSS) licensing for research and educational purposes from the GWU OSPO.

Contributing documents

Awesome-Contributing list
Examples
- Pandas: https://pandas.pydata.org/pandas-docs/stable/development/contributing.html
- Bokeh: https://docs.bokeh.org/en/latest/docs/dev_guide.html
- Zarr: https://zarr.readthedocs.io/en/stable/contributing.html
- Astropy: https://www.astropy.org/contribute.html

Sustainability

Stories
- SustainOSS - a space for conversations about sustaining Open Source
- PL Funding Panel with the Creators of Elm, Elixir, and Julia - addressing how the creation of programming languages gets funded

About this repository

Code of Conduct

This project/repository follows the Contributor Covenant Code of Conduct. By participating in this project you agree to abide by its terms. Please report any violations or concerns to Daniel S. Katz at d.katz@ieee.org

Contributing

Thanks for considering contributing to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license. Whenever you add Content to a repository containing notice of a license, you license that Content under the same terms, and you agree that you have the right to license that Content under those terms. If you have a separate agreement to license that Content under different terms, such as a contributor license agreement, that agreement will supersede.

Authors and credit

If you contribute to this work, such as by a pull request (PR), please also add yourself to the AUTHORS.md file in the same PR, ideally with your real name, your GitHub username, and your ORCID

If you use this work, please credit/cite it and the authors.

Submitting a pull request

Fork and clone the repository
Create a new branch: git checkout -b my-branch-name
Make your change
Push to your fork and submit a pull request
Pat yourself on the back and wait for your pull request to be reviewed and merged.

Owner

Name: corsa-center
Login: corsa-center
Kind: organization

Repositories: 1
Profile: https://github.com/corsa-center

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this work, please credit/cite it and the authors."
abstract: "Collecting guidance, documents, examples, templates for open-source software project, such as on governance, roadmaps, contributing, license, code of conduct"
authors:
- family-names: "Katz"
  given-names: "Daniel S."
  orcid: "https://orcid.org/0000-0001-5934-7525"
- family-names: "Forbes"
  given-names: "Megan"
  orcid: "https://orcid.org/0000-0002-2611-1441"
- family-names: "Silen"
  given-names: "Leah"
- family-names: "Curcuru"
  given-names: "Shane"
  orcid: "https://orcid.org/0000-0002-7530-3108"
- family-names: "Hucka"
  given-names: "Michael"
  orcid: "https://orcid.org/0000-0001-9105-5960"
- family-names: "Tang"
  given-names: "Yuan"
  orcid: "https://orcid.org/0000-0001-5243-233X"
- family-names: "Branan"
  given-names: "Bill"
  orcid: "https://orcid.org/0000-0002-4735-6624"
- family-names: "Richard"
  given-names: "Littauer"
  orcid: "https://orcid.org/0000-0001-5428-7535"
title: "Open-source software project documents"
date-released: 2025-02-22
url: "https://github.com/corsa-center/oss-documents"
license: "CC-BY-4.0"
repository-code: "https://github.com/corsa-center/oss-documents"
keywords:
- documentation
- docs
- open-source
type: "software"

GitHub Events

Total

Watch event: 24
Issue comment event: 6
Push event: 7
Pull request review event: 1
Pull request review comment event: 1
Pull request event: 9
Fork event: 6

Last Year

Watch event: 24
Issue comment event: 6
Push event: 7
Pull request review event: 1
Pull request review comment event: 1
Pull request event: 9
Fork event: 6

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 5
Average time to close issues: N/A
Average time to close pull requests: about 4 hours
Total issue authors: 0
Total pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.2
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 5
Average time to close issues: N/A
Average time to close pull requests: about 4 hours
Issue authors: 0
Pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.2
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

RichardLitt (4)
terrytangyuan (2)
caniszczyk (1)
bbranan (1)
lsilen (1)
mhucka (1)
ShaneCurcuru (1)