Skip to content

Commit f357763

Browse files
committed
Refactored CONTRIBUTING guide
1 parent 4eccd34 commit f357763

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
# Contributing to OS2 Documentation
22

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.
3+
Contributors to the documentation can be project managers, technical editors, developers, and end-users. We welcome all contributions that help improve our documentation.
44

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/)
5+
To ensure our documentation stays resilient and up-to-date, we employ the use of the open practice of [Docs As Code](https://openpracticelibrary.com/practice/docs-as-code/) and the open [Markdown](https://en.wikipedia.org/wiki/Markdown) format for ease of collaboration and quality control.
66

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]
7+
To promote digital sovereignty, interoperability, reuse, transparency and resillience, we adhere to the [Standard for Public Code](https://standard.publiccode.net/), a framework maintained by the [Foundation for Public Code](https://publiccode.net/who-we-are/).
8+
<br>
9+
<br>
1010

11-
## How to Contribute
11+
## 🚀 Quick start
1212

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.
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+
2. Follow the criteria from [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html), [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html) and [Document codebase Maturity]()
15+
in one or several text documents using the Markdown format.
16+
3. 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.
17+
4. 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).
18+
5. Collaborate on documentation branches with issues assigned to you by the maintainers.
1419

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.
20+
> 📚 Read more about:
21+
>
22+
> How to use [Markdown](https://www.writethedocs.org/guide/writing/markdown/) to collaborate on documentation
23+
> How [Just the Docs](https://just-the-docs.github.io/just-the-docs/) is used to generate a documentation site from your markdown files.
1824
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)