|
| 1 | +# Contributing to OpenChain's Reference-Material Repository |
| 2 | + |
| 3 | +## Licenses for Contributions |
| 4 | + |
| 5 | +To align with our project charter: |
| 6 | +* Case studies should be licensed under CC-BY-SA, or a more permissive license; |
| 7 | +* Other contributions should be licensed under CC-0. |
| 8 | + |
| 9 | +## Types of Contribution |
| 10 | + |
| 11 | +This repository contains documentation. Typical contributions are: |
| 12 | +* Translations of existing documents from English to other languages. |
| 13 | + * This includes *re*-translation of documents when updates happen to the original document. |
| 14 | +* Corrections and improvements to existing documents: fixing typos, spelling, grammar, phrasing. |
| 15 | +* Conversion of documents from other formats to Markdown. |
| 16 | +* Reviewing existing Pull Requests. |
| 17 | +* Submitting issues identifying problems with current content, or suggesting new content. |
| 18 | +* Working on existing issues. |
| 19 | + |
| 20 | +Other contributions are welcomed too, such as: |
| 21 | +* Guides and playbooks for adoption of the OpenChain ISO/IEC standard; |
| 22 | +* Case studies, indicating how an organization has achieved conformance, and the benefits gained thereby. |
| 23 | + |
| 24 | +Contributions are also welcomed through discussions: |
| 25 | +* Online discussions via Slack and mailing lists. |
| 26 | +* Zoom calls - the OpenChain project runs regular calls, plus other calls as necessary. |
| 27 | + |
| 28 | +## Submitting Bug Reports |
| 29 | + |
| 30 | +Issues with the documentation in this repository can be logged as issues in GitHub, |
| 31 | +at https://github.com/OpenChain-Project/Reference-Material/issues. |
| 32 | + |
| 33 | +TODO: Advice/Practice for use of the labels for issues: bug, documentation, duplicate, enhancement, good first issue, help wanted, invalid, question, wontfix. |
| 34 | + |
| 35 | +TODO: Expectations about response times (right now, it doesn't look good....) |
| 36 | + |
0 commit comments