Skip to content

Commit 151200d

Browse files
committed
Added a CONTRIBUTIING.md
1 parent 2493f20 commit 151200d

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing to OS2 Documentation
2+
3+
Contributors to the documentation can be project managers, technical editors, developers, and end-users. We welcome contributions that help improve our documentation and ensure it meets the needs of our community.
4+
5+
To open up our codebases and fosters collaboration and transparency and encourage more organizations to use and adapt our open source products OS2 follows the documentation criteria from the [Standard for Public Code](https://standard.publiccode.net/)
6+
7+
- [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html)
8+
- [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html)
9+
- [Document codebase Maturity]
10+
11+
## How to Contribute
12+
13+
1. Start by writing a README following the simple criteria in the above guides from Standard for Public Code. For at fast and simple way to accomplish this, you can fill out the placeholders in the PROJECT_README_TEMPLATE.md and [rename it](https://docs.github.com/en/repositories/working-with-files/managing-files/renaming-a-file) to README.md, replacing the Quick start guide for this template with your projects information.
14+
15+
2. Document further suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
16+
3. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
17+
4. Collaborate on documentation branches with issues assigned to you by the maintainers.
18+
19+
[Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
20+
21+
22+
Following these criteria not only opens up our codebase and fosters collaboration and transparency, but also encourages more organizations to use and adapt our open source products.

0 commit comments

Comments
 (0)