Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 2.33 KB

Contributing to OpenChain's Reference-Material Repository

Licenses for Contributions

To align with our project charter:

  • Case studies should be licensed under CC-BY-SA, or a more permissive license;
  • Other contributions should be licensed under CC-0.

Types of Contribution

This repository contains documentation. Typical contributions are:

  • Translations of existing documents from English to other languages.
    • This includes re-translation of documents when updates happen to the original document.
  • Corrections and improvements to existing documents: fixing typos, spelling, grammar, phrasing.
  • Conversion of documents from other formats to Markdown.
  • Reviewing existing Pull Requests.
  • Submitting issues identifying problems with current content, or suggesting new content.
  • Working on existing issues.

Other contributions are welcomed too, such as:

  • Guides and playbooks for adoption of the OpenChain ISO/IEC standard;
  • Case studies, indicating how an organization has achieved conformance, and the benefits gained thereby.

Contributions are also welcomed through discussions:

  • Online discussions via Slack and mailing lists.
  • Zoom calls - the OpenChain project runs regular calls, plus other calls as necessary.

Submitting Bug Reports

Issues with the documentation in this repository can be logged as issues in GitHub.

Submitting Corrections and Contributions

Please create a pull request (PR). If you are new to contributions through GitHub, these resources may help:

TODO: Advice/Practice for use of the labels for issues: bug, documentation, duplicate, enhancement, good first issue, help wanted, invalid, question, wontfix.

TODO: Expectations about response times (right now, it doesn't look good....)