Skip to content

Commit 91c0d23

Browse files
Add a CONTRIBUTING.md file.
This is a first draft, and needs a bunch of work and inputs from other people more familiar with the project.
1 parent 043bfd7 commit 91c0d23

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing to OpenChain's Reference-Material Repository
2+
3+
## Types of Contribution
4+
5+
This repository contains documentation. Typical contributions are:
6+
* Translations of existing documents from English to other languages.
7+
* This includes *re*-translation of documents when updates happen to the original document.
8+
* Corrections and improvements to existing documents: fixing typos, spelling, grammar, phrasing.
9+
* Conversion of documents from other formats to Markdown.
10+
* Reviewing existing Pull Requests.
11+
* Submitting issues identifying problems with current content, or suggesting new content.
12+
* Working on existing issues.
13+
14+
Other contributions are welcomed too, such as:
15+
* Guides and playbooks for adoption of the OpenChain ISO/IEC standard;
16+
17+
Contributions are also welcomed through discussions:
18+
* Online discussions via Slack and mailing lists.
19+
* Zoom calls - the OpenChain project runs regular calls, plus other calls as necessary.
20+
21+
## Submitting Bug Reports
22+
23+
Issues with the documentation in this repository can be logged as issues in GitHub,
24+
at https://github.com/OpenChain-Project/Reference-Material/issues.
25+
26+
TODO: Advice/Practice for use of the labels for issues: bug, documentation, duplicate, enhancement, good first issue, help wanted, invalid, question, wontfix.
27+
28+
TODO: Expectations about response times (right now, it doesn't look good....)
29+

0 commit comments

Comments
 (0)