Skip to content

Commit 09bfb05

Browse files
committed
feat: Add contributing, governance, and privacy documents
- Created CONTRIBUTING.md with guidelines for contributing to the project. - Added GOVERNANCE.md outlining project structure and decision-making processes. - Introduced LICENSE.md with the European Union Public License v. 1.2. - Implemented PRIVACY.md detailing data collection and protection measures. - Established SECURITY.md for reporting vulnerabilities and security measures. - Added SUPPORT.md for user assistance and support policy. - Created code style and commit style guidelines in docs/code-style.md and docs/commit-style.md. - Added pull request template in docs/pull_request_template.md. - Updated package.json and pnpm-lock.yaml to reflect changes in package naming conventions.
1 parent 9199b74 commit 09bfb05

20 files changed

+962
-31
lines changed

.github/CODEOWNERS

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Lines starting with '#' are comments.
2+
# Each line is a file pattern followed by one or more owners.
3+
4+
# These owners will be the default owners for everything in the repo.
5+
* @devbyray

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/copilot-instructions.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Always use simple languages, be friendly, informal and avoid jargon. This will make your code easier to understand for everyone.
2+
3+
Always use code according to the /docs/code-style.md guide. This will make your code easier to understand for everyone.
4+
5+
The commit messages should be according to the /docs/commit-style.md guide. This will make your code easier to understand for everyone.
6+
7+
Use @terminal when answering questions about Git.
8+
9+

.github/workflows/publish-packages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
with:
3535
node-version: '20'
3636
registry-url: 'https://npm.pkg.github.com'
37-
scope: '@devbyrayray'
37+
scope: '@devbyray'
3838
cache: 'pnpm'
3939

4040
- name: Setup PNPM

.vscode/settings.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"github.copilot.chat.codeGeneration.instructions":[
3+
{
4+
"file": "docs/code-style.md",
5+
}
6+
],
7+
"github.copilot.chat.commitMessageGeneration.instructions": [
8+
{
9+
"file": "docs/commit-style.md"
10+
}
11+
]
12+
}

ACCESSIBILITY.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Accessibility Statement
2+
3+
## Our Commitment
4+
5+
We are committed to ensuring our project is accessible to everyone. We aim to comply with Web Content Accessibility Guidelines (WCAG) 2.1 Level AA standards.
6+
7+
## Compliance Status
8+
9+
Our project aims to be compliant with:
10+
11+
- WCAG 2.1 Level AA
12+
- Section 508 requirements
13+
- ADA requirements
14+
15+
## Features
16+
17+
Accessibility features in our project include:
18+
19+
- Keyboard navigation support
20+
- Screen reader compatibility
21+
- Sufficient color contrast
22+
- Text resizing without loss of functionality
23+
- Alternative text for images
24+
25+
## Known Issues
26+
27+
We are currently working to address these known accessibility issues:
28+
29+
- [List any known issues]
30+
31+
## Testing
32+
33+
We regularly test our application for accessibility using:
34+
35+
- Automated testing tools
36+
- Manual testing
37+
- Screen reader testing
38+
- Keyboard navigation testing
39+
40+
## Feedback
41+
42+
We welcome your feedback on the accessibility of this project. Please report accessibility barriers using one of these methods:
43+
44+
- Submit an issue on our GitHub repository
45+
- Email us at [[email protected]](mailto:[email protected])
46+
47+
## This Statement
48+
49+
This statement was last updated on [DATE].

CODE_OF_CONDUCT.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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 and orientation.
10+
11+
## Our Standards
12+
13+
Examples of behavior that contributes to creating a positive environment include:
14+
15+
* Using welcoming and inclusive language
16+
* Being respectful of differing viewpoints and experiences
17+
* Gracefully accepting constructive criticism
18+
* Focusing on what is best for the community
19+
* Showing empathy towards other community members
20+
21+
Examples of unacceptable behavior include:
22+
23+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
24+
* Trolling, insulting/derogatory comments, and personal or political attacks
25+
* Public or private harassment
26+
* Publishing others' private information without explicit permission
27+
* Other conduct which could reasonably be considered inappropriate in a professional setting
28+
29+
## Enforcement Responsibilities
30+
31+
Project maintainers are responsible for clarifying the standards of acceptable
32+
behavior and are expected to take appropriate and fair corrective action in
33+
response to any instances of unacceptable behavior.
34+
35+
## Reporting Violations
36+
37+
If you experience or witness unacceptable behavior, please report it by contacting
38+
the project team at [INSERT EMAIL ADDRESS]. All reports will be handled with
39+
discretion.
40+
41+
## Enforcement
42+
43+
Violations of the Code of Conduct may result in temporary or permanent exclusion
44+
from project participation, as determined by project maintainers.
45+
46+
## Attribution
47+
48+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
49+
version 2.0, available at
50+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to This Project
2+
3+
Thank you for your interest in contributing to our project! This document provides guidelines and instructions for contributing.
4+
5+
## Code of Conduct
6+
7+
Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) before contributing.
8+
9+
## How Can I Contribute?
10+
11+
### Reporting Bugs
12+
13+
- Check if the bug has already been reported in the Issues section
14+
- Use the bug report template when creating a new issue
15+
- Provide detailed steps to reproduce the bug
16+
- Include screenshots if applicable
17+
18+
### Suggesting Features
19+
20+
- Check if the feature has already been suggested
21+
- Use the feature request template
22+
- Explain why the feature would be useful
23+
24+
### Pull Requests
25+
26+
1. Fork the repository
27+
2. Create a new branch (`git checkout -b feature/amazing-feature`)
28+
3. Make your changes
29+
4. Commit with clear messages (`git commit -m 'Add some amazing feature'`)
30+
5. Push to your branch (`git push origin feature/amazing-feature`)
31+
6. Open a Pull Request
32+
33+
## Development Process
34+
35+
- All development should happen in feature branches
36+
- Pull requests require at least one review before merging
37+
- All tests must pass before a PR can be merged
38+
39+
## Style Guidelines
40+
41+
- Follow the existing code style
42+
- Write clear comments and documentation
43+
- Keep commit messages concise and descriptive
44+
45+
Thank you for contributing!

GOVERNANCE.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Project Governance
2+
3+
## Project Structure
4+
5+
This project is maintained by a team of volunteers and follows a community-driven governance model.
6+
7+
## Roles and Responsibilities
8+
9+
### Project Maintainers
10+
11+
- Review and merge pull requests
12+
- Release new versions
13+
- Establish project direction
14+
- Manage community interactions
15+
16+
### Contributors
17+
18+
- Submit pull requests
19+
- Report bugs and suggest features
20+
- Participate in discussions
21+
- Help with documentation and testing
22+
23+
### Users
24+
25+
- Provide feedback
26+
- Report bugs
27+
- Suggest features
28+
- Spread the word about the project
29+
30+
## Decision Making Process
31+
32+
1. **Proposals**: Anyone can propose changes via issues or discussions
33+
2. **Feedback**: Community feedback is gathered
34+
3. **Consensus**: We aim for consensus among maintainers
35+
4. **Implementation**: Once approved, changes are implemented
36+
37+
## Becoming a Maintainer
38+
39+
Contributors who show consistent, high-quality participation may be invited to become maintainers. The process includes:
40+
41+
1. Nomination by an existing maintainer
42+
2. Review of contribution history
43+
3. Consensus among existing maintainers
44+
4. Formal invitation
45+
46+
## Communication Channels
47+
48+
- GitHub Issues and Discussions
49+
- Community Chat (e.g., Discord, Slack)
50+
- Regular community calls
51+
- Mailing list
52+
53+
## Conflict Resolution
54+
55+
When conflicts arise, we follow this process:
56+
57+
1. Open discussion on the relevant platform
58+
2. Moderated debate with all stakeholders
59+
3. Attempt to reach consensus
60+
4. If consensus cannot be reached, maintainers make the final decision
61+
62+
## Changes to Governance
63+
64+
This governance document may evolve over time. Significant changes will be:
65+
66+
1. Proposed via pull request
67+
2. Open for community feedback
68+
3. Implemented only after maintainer consensus

0 commit comments

Comments
 (0)