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

• Open Source Guides, from GitHub
• OpenSSF Best Practices Badge Program
• Code for Science and Society's Digital Infrastructure Incubator resources
• Mozilla's Open Leadership Training Series's Best Practices in Working Open
• It Takes a Village: OS Sustainability for Cultural and Scientific Heritage

Governance

• Minimum Viable Governance
• Goverining Open
• CommunityRule
• CSCCE's November 2021 community call recap: Exploring community governance models
• Examples
  • napari: https://napari.org/stable/community/governance.html
  • NumPy: https://numpy.org/doc/stable/dev/governance/governance.html
  • SciML: https://sciml.ai/governance/
  • Astropy: Roles & Governance

Codes of Conduct

• Open Seed's Designing and enforcing a Code of Conduct by Saskia Freytag
• Open Source Guide's Your Code of Conduct
• rOpenSci's 2016 Highlights and Resources from Community Call v12: How do I create a code of conduct for my event/lab/codebase?
• Examples
  • Contributor Convenant: https://www.contributor-covenant.org
  • NumFOCUS: https://numfocus.org/code-of-conduct

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

Contributing documents

• 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

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 [email protected]

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

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