Skip to content

Commit 25f2e79

Browse files
authored
[Wiki] Sidebar and contribution flow update (#1573)
* sidebar and contribution update * title categories
1 parent 16f5abc commit 25f2e79

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

docs/wiki/Contribution guide - Contribution flow.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,14 @@ Once the contribution is implemented and the changes are pushed to your forked r
6565

6666
Finally, once your contribution is implemented and validated, open a PR for the CARML maintainers to review. Make sure you:
6767

68+
- Make sure you provide a meaningful PR title in the following format: `[<Category>] <PR title>`. For `[<Category>]` use one of the following, depending on which one is the primary improvement your PR intends to make:
69+
- `[Modules]`: For improvements to the CARML library.
70+
- `[CI environment]`: For improvements to the CI environment pipelines.
71+
- `[Static Validation]`: For improvements to global Pester tests.
72+
- `[Wiki]`: For improvements to the documentation.
73+
- `[Utilities]`: For improvements to the tools in the utilities.
74+
- `[Fixes]`: For bug fixes when not specifically related to any of the above categories.
75+
- Make sure you provide a meaningful PR description.
6876
- Follow instructions you find in the PR template.
6977
- Set your Github handle as assignee.
7078
- Reference the issue number as per the [Create or pick up an issue](#create-or-pick-up-an-issue) step.

docs/wiki/_Sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [CARML overview](./The%20context%20-%20CARML%20overview)
66
- [The library](./The%20context%20-%20CARML%20library)
77
- [The CI environment](./The%20context%20-%20CARML%20CI%20environment)
8+
- [Logical layers and personas](./The%20context%20-%20Logical%20layers%20and%20personas)
89
- [Getting started](./Getting%20started)
910
- [**Scenario 1:** Consume module library only](./Getting%20started%20-%20Scenario%201%20Consume%20library)
1011
- [**Scenario 2:** Onboard module library and CI environment](./Getting%20started%20-%20Scenario%202%20Onboard%20module%20library%20and%20CI%20environment)

0 commit comments

Comments
 (0)