Skip to content

Commit 38b453a

Browse files
niksbannaniksbanna
authored
Merge pull request #1 from niksbanna/copilot/add-readme-license-code-of-conduct
Add comprehensive documentation and GitHub workflows
2 parents b779d13 + fa97fda commit 38b453a

9 files changed

Lines changed: 644 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
<!-- A clear and concise description of what the bug is -->
11+
12+
## Steps To Reproduce
13+
1. Go to '...'
14+
2. Click on '...'
15+
3. Scroll down to '...'
16+
4. See error
17+
18+
## Expected Behavior
19+
<!-- A clear and concise description of what you expected to happen -->
20+
21+
## Actual Behavior
22+
<!-- A clear and concise description of what actually happened -->
23+
24+
## Screenshots
25+
<!-- If applicable, add screenshots to help explain your problem -->
26+
27+
## Environment
28+
- OS: [e.g. Windows 10, macOS 12.0, Ubuntu 20.04]
29+
- Browser: [e.g. Chrome 96, Firefox 95, Safari 15]
30+
- Node.js version: [e.g. 18.0.0]
31+
- npm version: [e.g. 8.0.0]
32+
33+
## Additional Context
34+
<!-- Add any other context about the problem here -->
35+
36+
## Possible Solution
37+
<!-- Optional: Suggest a fix or reason for the bug -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
<!-- A clear and concise description of the feature you'd like to see -->
11+
12+
## Problem Statement
13+
<!-- Is your feature request related to a problem? Please describe. -->
14+
<!-- Example: I'm always frustrated when [...] -->
15+
16+
## Proposed Solution
17+
<!-- A clear and concise description of what you want to happen -->
18+
19+
## Alternatives Considered
20+
<!-- A clear and concise description of any alternative solutions or features you've considered -->
21+
22+
## Benefits
23+
<!-- How would this feature benefit the project and its users? -->
24+
25+
## Implementation Suggestions
26+
<!-- Optional: Any ideas on how this could be implemented? -->
27+
28+
## Screenshots/Mockups
29+
<!-- If applicable, add mockups or examples to help explain your feature request -->
30+
31+
## Additional Context
32+
<!-- Add any other context or screenshots about the feature request here -->

‎.github/dependabot.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
version: 2
2+
updates:
3+
# Enable version updates for npm
4+
- package-ecosystem: "npm"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
open-pull-requests-limit: 10
10+
labels:
11+
- "dependencies"
12+
- "automated"
13+
commit-message:
14+
prefix: "⬆️"
15+
include: "scope"
16+
reviewers:
17+
- "niksbanna"
18+
19+
# Enable version updates for GitHub Actions
20+
- package-ecosystem: "github-actions"
21+
directory: "/"
22+
schedule:
23+
interval: "weekly"
24+
day: "monday"
25+
labels:
26+
- "dependencies"
27+
- "github-actions"
28+
commit-message:
29+
prefix: "⬆️"

‎.github/pull_request_template.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
## Description
2+
<!-- Provide a brief description of the changes in this PR -->
3+
4+
## Type of Change
5+
<!-- Mark the relevant option with an "x" -->
6+
7+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
8+
- [ ] ✨ New feature (non-breaking change which adds functionality)
9+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] 📝 Documentation update
11+
- [ ] 🎨 Code style update (formatting, renaming)
12+
- [ ] ♻️ Refactoring (no functional changes)
13+
- [ ] 🚀 Performance improvement
14+
- [ ] ✅ Test update
15+
- [ ] 🔧 Build/config update
16+
- [ ] 🔒 Security update
17+
18+
## Related Issue
19+
<!-- Link to the issue this PR addresses -->
20+
Closes #(issue)
21+
22+
## Changes Made
23+
<!-- List the specific changes made in this PR -->
24+
25+
-
26+
-
27+
-
28+
29+
## Screenshots (if applicable)
30+
<!-- Add screenshots to help explain your changes -->
31+
32+
## Testing
33+
<!-- Describe the tests you ran to verify your changes -->
34+
35+
- [ ] I have tested this code locally
36+
- [ ] I have run `npm run lint` and fixed any errors
37+
- [ ] I have run `npm run build` successfully
38+
- [ ] I have tested on multiple browsers (if UI changes)
39+
- [ ] I have tested responsive design (if UI changes)
40+
41+
## Checklist
42+
<!-- Mark completed items with an "x" -->
43+
44+
- [ ] My code follows the style guidelines of this project
45+
- [ ] I have performed a self-review of my own code
46+
- [ ] I have commented my code, particularly in hard-to-understand areas
47+
- [ ] I have made corresponding changes to the documentation
48+
- [ ] My changes generate no new warnings
49+
- [ ] I have added tests that prove my fix is effective or that my feature works
50+
- [ ] New and existing unit tests pass locally with my changes
51+
- [ ] Any dependent changes have been merged and published
52+
53+
## Additional Context
54+
<!-- Add any other context about the pull request here -->

‎.github/workflows/ci.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main, develop ]
8+
9+
jobs:
10+
lint-and-build:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
node-version: [18.x, 20.x]
16+
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v4
20+
21+
- name: Setup Node.js ${{ matrix.node-version }}
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: ${{ matrix.node-version }}
25+
cache: 'npm'
26+
27+
- name: Install dependencies
28+
run: npm ci
29+
30+
- name: Run linter
31+
run: npm run lint
32+
33+
- name: Build project
34+
run: npm run build
35+
36+
- name: Upload build artifacts
37+
if: matrix.node-version == '20.x'
38+
uses: actions/upload-artifact@v4
39+
with:
40+
name: dist
41+
path: dist/
42+
retention-days: 7

‎CODE_OF_CONDUCT.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
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, caste, color, religion, or sexual
10+
identity 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 overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
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 address,
35+
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 through the
63+
GitHub issue tracker or by contacting the project maintainers directly.
64+
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)