Skip to content

Commit 448a68c

Browse files
committed
More lnks to official github docs added
1 parent ffa1060 commit 448a68c

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,24 @@
66
As a part of the documentation maintainer team...
77
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.
88

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.
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.
10+
- Organize your work in [Milestones](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/about-milestones)
11+
- [Use task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) to break down larger documentation work into manageble pieces.
12+
- [Assign labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) to prioritize and classify your issues and maintain an overview on what needs to be done.
1013

1114
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,
1215

16+
> [!TIP]
17+
> If you get stuck, os2 can help, just get in touch [[email protected]](mailto:[email protected])
18+
1319

1420
## 🧑‍🦰 Contributors Guide
1521
As a contributor
22+
1. Document suggestions and improvements by [raising issues feature](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.
1623

24+
2. 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).
1725

18-
Changes and suggestions are raised as issues
19-
Standardized version controlled workflow.
20-
21-
OS2 are currently using GitHub
22-
26+
3. Using simple [Markdown](), collaborate on documentation branches with issues assigned to you by the maintainers.
2327

2428
[Browse documentation][Just the Docs] to learn more about the templates features for formatting your documents
2529

0 commit comments

Comments
 (0)