Skip to content

Commit 13b71cd

Browse files
devhiteshkdevhiteshk
committed
Update Community Standards
1 parent 8feabc9 commit 13b71cd

10 files changed

Lines changed: 270 additions & 40 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Funding links shown on your GitHub repository
2+
# Supported platforms: github, patreon, open_collective, ko_fi, tidelift,
3+
# community_bridge, liberapay, issuehunt, polar,
4+
# buy_me_a_coffee, thanks_dev, custom
5+
6+
github: devhiteshk
7+
# ko_fi: your-ko-fi-username
8+
# patreon: your-patreon-username
9+
# buy_me_a_coffee: your-bmc-username
10+
# custom: https://your-custom-donation-url.com

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
2+
name: 🐛 Bug Report
3+
about: Report a reproducible bug or unexpected behavior
4+
title: "[Bug] "
5+
labels: bug, needs-triage
6+
assignees: ""
87
---
98

10-
**Describe the bug**
9+
## Describe the Bug
10+
1111
A clear and concise description of what the bug is.
1212

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
13+
## Steps to Reproduce
14+
1515
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
16+
2. Click on '...'
17+
3. Scroll down to '...'
1818
4. See error
1919

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
20+
## Expected Behavior
21+
22+
A clear description of what you expected to happen.
23+
24+
## Actual Behavior
25+
26+
A clear description of what actually happens. Include screenshots if relevant.
2227

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
28+
## Environment
2529

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
30+
| Detail | Value |
31+
|---|---|
32+
| OS | e.g. macOS 15, Windows 11 |
33+
| Browser / Runtime | e.g. Chrome 126, Node 22 |
34+
| Project Version | e.g. 1.2.3 |
3035

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+
## Additional Context
3637

37-
**Additional context**
38-
Add any other context about the problem here.
38+
Add any other context about the problem here (logs, stack traces, related issues).

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
blank_issues_enabled: false
2+
3+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
2+
name: 🚀 Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ""
87
---
98

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 [...]
9+
## Problem Statement
10+
11+
Is your feature request related to a problem? Describe it clearly.
12+
e.g. "I'm frustrated when..."
13+
14+
## Proposed Solution
15+
16+
A clear description of what you'd like to happen.
17+
18+
## Alternatives Considered
1219

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
20+
Any alternative solutions or features you've considered and why you ruled them out.
1521

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
22+
## Additional Context
1823

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
24+
Add any mockups, screenshots, or other context that helps explain your idea.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: ❓ Question / Support
3+
about: Ask a question or get help with something
4+
title: "[Question] "
5+
labels: question
6+
assignees: ""
7+
---
8+
9+
## What Do You Need Help With?
10+
11+
Describe your question or what you're trying to accomplish.
12+
13+
## What Have You Tried?
14+
15+
Steps you've already taken or documentation you've read.
16+
17+
## Additional Context
18+
19+
Any code snippets, logs, or links that help explain the situation.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## Summary
2+
3+
<!-- A short description of what this PR does and why. -->
4+
5+
Closes #<!-- issue number -->
6+
7+
---
8+
9+
## Type of Change
10+
11+
<!-- Check all that apply -->
12+
13+
- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
14+
- [ ] 🚀 New feature (non-breaking change that adds functionality)
15+
- [ ] 💥 Breaking change (fix or feature that causes existing functionality to change)
16+
- [ ] 📝 Documentation update
17+
- [ ] 🧹 Refactor / chore (no functional changes)
18+
- [ ] ✅ Test update
19+
20+
---
21+
22+
## Changes Made
23+
24+
<!-- List the key changes in bullet points -->
25+
26+
-
27+
-
28+
-
29+
30+
---
31+
32+
## How to Test
33+
34+
<!-- Step-by-step instructions to verify this PR works as expected -->
35+
36+
1.
37+
2.
38+
3.
39+
40+
---
41+
42+
## Checklist
43+
44+
- [ ] My code follows the project's style guide (`pnpm lint` passes)
45+
- [ ] I have added or updated tests as needed
46+
- [ ] All existing tests pass (`pnpm test` passes)
47+
- [ ] I have updated the documentation where necessary
48+
- [ ] I have added an entry to `CHANGELOG.md` under `[Unreleased]`
49+
- [ ] My branch is up to date with `main`
50+
51+
---
52+
53+
## Screenshots / Recordings
54+
55+
<!-- If applicable, add screenshots or screen recordings to help reviewers -->

‎.github/workflows/ci.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main, develop]
6+
pull_request:
7+
branches: [main, develop]
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
lint-and-test:
15+
name: Lint & Test
16+
runs-on: ubuntu-latest
17+
18+
strategy:
19+
matrix:
20+
node-version: [20.x, 22.x]
21+
22+
steps:
23+
- name: Checkout code
24+
uses: actions/checkout@v4
25+
26+
- name: Set up Node.js ${{ matrix.node-version }}
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: ${{ matrix.node-version }}
30+
cache: "pnpm"
31+
32+
- name: Install pnpm
33+
uses: pnpm/action-setup@v4
34+
with:
35+
version: 9
36+
37+
- name: Install dependencies
38+
run: pnpm install --frozen-lockfile
39+
40+
- name: Run linter
41+
run: pnpm lint
42+
43+
- name: Run tests
44+
run: pnpm test --run
45+
46+
- name: Build
47+
run: pnpm build

‎.github/workflows/release.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*.*.*"
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
release:
13+
name: Create GitHub Release
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
with:
20+
fetch-depth: 0
21+
22+
- name: Create Release
23+
uses: softprops/action-gh-release@v2
24+
with:
25+
body_path: CHANGELOG.md
26+
generate_release_notes: true
27+
env:
28+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎CODEOWNERS‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# CODEOWNERS
2+
# Each line is a file pattern followed by one or more owners.
3+
# Owners are automatically requested for review when someone opens a
4+
# pull request that modifies the matched files.
5+
# More info: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
6+
7+
# Global owner — fallback for everything not matched below
8+
* @devhiteshk
9+
10+
# Community health files
11+
/README.md @devhiteshk
12+
/CONTRIBUTING.md @devhiteshk
13+
/CODE_OF_CONDUCT.md @devhiteshk
14+
/SECURITY.md @devhiteshk
15+
/LICENSE @devhiteshk
16+
17+
# GitHub config
18+
/.github/ @devhiteshk
19+
20+
# Source code
21+
/src/ @devhiteshk
22+
23+
# CI/CD
24+
/.github/workflows/ @devhiteshk

‎SECURITY.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Only the latest stable release receives security updates.
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 1.x | ✅ Yes |
10+
| < 1.0 | ❌ No |
11+
12+
## Reporting a Vulnerability
13+
14+
**Please do not open a public GitHub issue for security vulnerabilities.**
15+
16+
Instead, report them responsibly by emailing **your-email@example.com** with the subject line:
17+
18+
```
19+
[SECURITY] <short description>
20+
```
21+
22+
Include the following in your report:
23+
24+
- A description of the vulnerability and its potential impact
25+
- Step-by-step instructions to reproduce it
26+
- Any proof-of-concept code or screenshots
27+
- The version(s) affected
28+
29+
### What to Expect
30+
31+
- **Acknowledgment** within 48 hours
32+
- **Status update** within 7 days (accepted, declined, or needs more info)
33+
- **Fix timeline** communicated once the issue is confirmed
34+
- **Credit** in the release notes if you'd like it (opt-in)
35+
36+
We ask that you give us reasonable time to address the issue before any public disclosure. We're committed to working with security researchers in good faith.
37+
38+
## Preferred Languages
39+
40+
We prefer all communications in English.

0 commit comments

Comments
 (0)