Skip to content

Commit ffa1060

Browse files
committed
Maintainers guide
1 parent 12b182a commit ffa1060

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,28 @@
22

33
## How to use this template for documenting your OS2 project
44

5+
## 👷 Maintainers guide
6+
As a part of the documentation maintainer team...
7+
1. Start by [creating a documentation repository in your project, from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), including only the main branch.
58

6-
[Browse documentation][Just the Docs] to learn more about features for formatting your documents
9+
2. Use the repositorys built-in [issues feature](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) to manage all changes, task and suggestions for improvements. [Organize your work in Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones) and [use task lists to break down larger documentation work](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists). Use [labels to prioritize and classify your issues](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) to maintain an overview on what needs to be done.
10+
11+
3. Stay on top of proposed changes to the documentation by [reviewing and merging Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) to your documentation repository,
12+
13+
14+
## 🧑‍🦰 Contributors Guide
15+
As a contributor
16+
17+
18+
Changes and suggestions are raised as issues
19+
Standardized version controlled workflow.
20+
21+
OS2 are currently using GitHub
22+
23+
24+
[Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
25+
26+
Content guide:
727

828
Documentation in OS2 products must follow the documentation criteria from the [Standard for Public Code](https://standard.publiccode.net/)
929

0 commit comments

Comments
 (0)