Skip to content

Commit ef77b44

Browse files
committed
Sign SHO: Initial version
1 parent c2ed514 commit ef77b44

14 files changed

+4461
-2
lines changed

.github/.cSpell.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"version": "0.2",
3+
"language": "en-GB",
4+
"words": [
5+
".adoc"
6+
]
7+
}
8+

.github/CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

.github/Contributing.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
= Contributing to the project
2+
3+
Thank you for your interest in contributing to this project! We value your contributions and strive to create an open and welcoming environment. This document outlines the guidelines for participating and ensuring a smooth collaboration process.
4+
5+
== Code of conduct
6+
All contributors are expected to adhere to our project's Code of Conduct. Please read it before contributing:
7+
8+
- **link:CODE_OF_CONDUCT.adoc[Code of Conduct]**
9+
10+
== Contribution Guidelines
11+
12+
=== General Guidelines
13+
- Follow our coding standards and best practices.
14+
- Ensure that your changes align with the link:ReadMe.adoc[project’s goals] and link:Roadmap.adoc[roadmap].
15+
- Open an issue before starting significant work to gather feedback.
16+
- All code must be reviewed before merging.
17+
18+
=== British English Convention
19+
- Use **British English** for all comments, documentation, and discussions. A list of spelling differences between British and American English can be found link:https://www.britishcouncilfoundation.id/en/english/articles/british-and-american-english[here].
20+
- Maintain clear and concise documentation.
21+
22+
== Developer Certificate of Origin (DCO)
23+
Before contributing, you must agree to the Developer Certificate of Origin (DCO). This ensures that all contributions are properly licensed and attributable:
24+
25+
- **link:DCO[Developer Certificate of Origin]**
26+
27+
== License
28+
By contributing to this project, you agree that your contributions will be licensed under the project's license:
29+
30+
- **link:LICENSE[Project License]**
31+
32+
== Governance
33+
The project follows a structured governance model. Refer to the governance document for more details on roles, responsibilities, and decision-making processes:
34+
35+
- **link:Governance.adoc[Governance]**
36+
37+
== Roadmap
38+
To align contributions with the project's vision and future direction, please review our roadmap:
39+
40+
- **link:Roadmap.adoc[Project Roadmap]**
41+
42+
== Security
43+
If you discover a security vulnerability, please follow the responsible disclosure process outlined in our security policy:
44+
45+
- **Security.adoc[Security Policy]**
46+
47+
== Support
48+
For questions, issues, or general discussions, refer to the support guidelines:
49+
50+
- **Support.adoc[Support Guidelines]**
51+
52+
== Submitting Changes
53+
54+
1. **Fork the Repository**
55+
2. **Create a New Branch** for your feature or bug fix.
56+
3. **Commit Your Changes** following conventional commit messages.
57+
4. **Run Tests** to ensure your changes do not introduce issues.
58+
5. **Open a Pull Request** and link to the related issue.
59+
6. **Engage in Review** by addressing feedback and suggestions.
60+
61+
== Issues and Feature Requests
62+
- Before opening a new issue, check existing issues to avoid duplicates.
63+
- Clearly describe the issue or feature request with relevant details.
64+
- Label the issue appropriately for better tracking.
65+
66+
67+

.github/DCO

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
660 York Street, Suite 102,
6+
San Francisco, CA 94110 USA
7+
8+
Everyone is permitted to copy and distribute verbatim copies of this
9+
license document, but changing it is not allowed.
10+
11+
12+
Developer's Certificate of Origin 1.1
13+
14+
By making a contribution to this project, I certify that:
15+
16+
(a) The contribution was created in whole or in part by me and I
17+
have the right to submit it under the open source license
18+
indicated in the file; or
19+
20+
(b) The contribution is based upon previous work that, to the best
21+
of my knowledge, is covered under an appropriate open source
22+
license and I have the right under that license to submit that
23+
work with modifications, whether created in whole or in part
24+
by me, under the same open source license (unless I am
25+
permitted to submit under a different license), as indicated
26+
in the file; or
27+
28+
(c) The contribution was provided directly to me by some other
29+
person who certified (a), (b) or (c) and I have not modified
30+
it.
31+
32+
(d) I understand and agree that this project and the contribution
33+
are public and that a record of the contribution (including all
34+
personal information I submit with it, including my sign-off) is
35+
maintained indefinitely and may be redistributed consistent with
36+
this project or the open source license(s) involved.

.github/Governance.adoc

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
= Project Governance
2+
3+
This document outlines the governance model for the project, defining roles, responsibilities, and branch management strategy.
4+
5+
== Roles and Permissions
6+
The project follows a structured role-based access control model. The roles are defined as follows:
7+
8+
=== Read
9+
- Can view repository contents and discussions.
10+
- Can submit issues and comment on existing ones.
11+
- No write access.
12+
13+
=== Triage
14+
- Can label, categorize, and prioritize issues.
15+
- Can assist in reviewing and managing issue reports.
16+
- Cannot merge pull requests or modify the repository.
17+
18+
=== Write
19+
- Can create and push branches.
20+
- Can submit and review pull requests.
21+
- Can update documentation and contribute code.
22+
- Cannot modify project settings or manage permissions.
23+
24+
=== Maintain
25+
- Can approve and merge pull requests.
26+
- Responsible for reviewing and enforcing coding standards.
27+
- Can manage project workflows and CI/CD configurations.
28+
- Cannot delete the repository or change administrative settings.
29+
30+
=== Admin
31+
- Full control over repository settings and permissions.
32+
- Can manage roles and access levels.
33+
- Can enforce security policies and branch protections.
34+
- Responsible for repository governance and compliance.
35+
36+
== Branch Management Strategy
37+
38+
=== Default Branch
39+
- The default working branch for active development is **`development`**.
40+
- All new features and bug fixes must be merged into the **`development`** branch before being included in a release.
41+
42+
=== Historical Branches
43+
- Versioning follows **Semantic Versioning** (MAJOR.MINOR.PATCH).
44+
- Major and minor releases are archived as historical branches following the format:
45+
- `vX.Y` (e.g., `v1.0`, `v1.1`, `v2.0`)
46+
- Patch releases are handled within the latest minor release branch.
47+
48+
=== Branch Protection Rules
49+
- The **`development`** branch is protected and requires pull request reviews before merging.
50+
- Historical branches are read-only to preserve past versions.
51+
- Direct pushes to protected branches are restricted to **Maintain** and **Admin** roles.
52+
53+
== Decision-Making Process
54+
- Governance decisions are made by the **Admin** role in consultation with **Maintain** members.
55+
- Feature discussions, roadmaps, and major changes are discussed through issue tracking and proposal discussions.
56+
- Voting or consensus-based decision-making is used for impactful changes.
57+
58+
== Amendments
59+
This governance document may be updated as needed. Changes must be reviewed and approved by **Admin** before adoption.

0 commit comments

Comments
 (0)