Skip to content

Commit 8a955a6

Browse files
chore: add open-source repo health baseline
Set up lightweight OSS governance with contributing docs, conduct/security policies, PR template, and CI checks for lint/test/build on master PRs. Made-with: Cursor
1 parent 7874a33 commit 8a955a6

6 files changed

Lines changed: 174 additions & 0 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Code of Conduct
2+
3+
## Our pledge
4+
5+
We want this project to be welcoming and constructive for everyone.
6+
7+
## Expected behavior
8+
9+
- Be respectful and assume good intent.
10+
- Give actionable feedback, not personal attacks.
11+
- Keep discussions focused on the code/product problem.
12+
- Accept that maintainers may prioritize scope and focus.
13+
14+
## Unacceptable behavior
15+
16+
- Harassment, insults, hate speech, or threats.
17+
- Bad-faith contributions or spam.
18+
- Publishing private information without consent.
19+
20+
## Enforcement
21+
22+
Maintainers may remove comments/issues/PRs that violate this code.
23+
Repeated violations may result in a ban from participation.
24+
25+
## Reporting
26+
27+
If you experience or observe unacceptable behavior, contact:
28+
29+
`dot.systems@proton.me`
30+

.github/CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing
2+
3+
Thanks for helping improve `commitmentissues.dev`.
4+
5+
## Ground rules
6+
7+
- Keep PRs small and focused.
8+
- One concern per PR (bugfix, feature, docs, or refactor).
9+
- Preserve the existing product tone and UI style.
10+
- Do not introduce heavy dependencies unless clearly justified.
11+
12+
## Local setup
13+
14+
```bash
15+
npm install
16+
npm run dev
17+
```
18+
19+
Optional for higher GitHub API limits:
20+
21+
```env
22+
GITHUB_TOKEN=ghp_yourtoken
23+
```
24+
25+
## Before opening a PR
26+
27+
Run:
28+
29+
```bash
30+
npm run lint
31+
npm test
32+
```
33+
34+
If you changed runtime behavior, also run:
35+
36+
```bash
37+
npm run build
38+
```
39+
40+
## Branch and PR flow
41+
42+
1. Fork repo
43+
2. Create feature branch (`feat/...`, `fix/...`, `docs/...`, `chore/...`)
44+
3. Commit with clear message
45+
4. Open PR to `master`
46+
47+
## Issue hygiene
48+
49+
- Use issue templates when available.
50+
- Include reproduction steps for bugs.
51+
- Include acceptance criteria for feature requests.
52+
53+
## Scope expectations
54+
55+
Good first contributions:
56+
57+
- UI polish and micro-interactions
58+
- Small bug fixes
59+
- Docs improvements
60+
- Tests around `src/lib/scoring.ts`
61+
62+
Avoid in first PRs:
63+
64+
- Large rewrites
65+
- Broad architecture refactors
66+
- Unrelated cleanup mixed into feature work
67+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## What changed
2+
3+
-
4+
5+
## Why
6+
7+
-
8+
9+
## Checklist
10+
11+
- [ ] I tested my change locally (`npm run lint` and `npm test`)
12+
- [ ] I kept the scope focused and avoided unrelated refactors
13+
- [ ] I updated docs/screenshots if behavior or UI changed
14+
- [ ] I confirmed no secrets are added
15+
16+
## Screenshots (if UI change)
17+
18+
<!-- Add before/after images or a short clip -->
19+

.github/SECURITY.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Security Policy
2+
3+
If you discover a security issue, please do **not** open a public issue.
4+
5+
## Report privately
6+
7+
- Use GitHub security advisories for this repository, or
8+
- Email: `dot.systems@proton.me`
9+
10+
Please include:
11+
12+
- A clear description of the issue
13+
- Steps to reproduce
14+
- Potential impact
15+
- Suggested fix (if available)
16+
17+
We will acknowledge reports as quickly as possible and work on a fix.
18+

.github/workflows/ci.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches: [master]
6+
push:
7+
branches: [master]
8+
9+
jobs:
10+
validate:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
17+
- name: Setup Node
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: 20
21+
cache: npm
22+
23+
- name: Install dependencies
24+
run: npm ci
25+
26+
- name: Lint
27+
run: npm run lint
28+
29+
- name: Test
30+
run: npm test
31+
32+
- name: Build
33+
run: npm run build
34+

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,12 @@ GITHUB_TOKEN=ghp_yourtoken
8282
npm test
8383
```
8484

85+
## Contributing
86+
87+
- Read `.github/CONTRIBUTING.md` before opening a PR
88+
- Use the issue templates and PR template
89+
- CI runs lint, tests, and build on `master` PRs
90+
8591
## Project structure
8692

8793
```text

0 commit comments

Comments
 (0)