Skip to content

Commit 4281b8a

Browse files
committed
Add MIT license and GitHub repository polish
1 parent c6935f3 commit 4281b8a

10 files changed

Lines changed: 283 additions & 3 deletions

File tree

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug report
2+
description: Report a reproducible bug in Chrome Activity Reader
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Summary
11+
description: What happened?
12+
placeholder: Clear and concise bug summary.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: steps
18+
attributes:
19+
label: Steps to reproduce
20+
description: Provide exact steps.
21+
placeholder: |
22+
1. Open ...
23+
2. Click ...
24+
3. Observe ...
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: expected
30+
attributes:
31+
label: Expected behavior
32+
placeholder: What should happen?
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: actual
38+
attributes:
39+
label: Actual behavior
40+
placeholder: What actually happened?
41+
validations:
42+
required: true
43+
44+
- type: input
45+
id: chrome_version
46+
attributes:
47+
label: Chrome version
48+
placeholder: e.g. 134.0.x
49+
validations:
50+
required: true
51+
52+
- type: input
53+
id: extension_version
54+
attributes:
55+
label: Extension version
56+
placeholder: e.g. 0.1.1
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: evidence
62+
attributes:
63+
label: Logs / screenshots / artifacts
64+
description: Paste console errors, attach screenshots, or list artifact paths.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Project documentation
4+
url: https://github.com/baboonzero/chrome-activity-reader/blob/main/README.md
5+
about: Review setup, usage, and validation docs before opening an issue.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Feature request
2+
description: Propose an enhancement for Chrome Activity Reader
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: Problem statement
11+
description: What user problem does this solve?
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: proposal
17+
attributes:
18+
label: Proposed solution
19+
description: Describe the proposed behavior.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Alternatives considered
27+
description: List alternatives you considered.
28+
29+
- type: dropdown
30+
id: priority
31+
attributes:
32+
label: Priority
33+
options:
34+
- High
35+
- Medium
36+
- Low
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: evidence
42+
attributes:
43+
label: Mockups / references
44+
description: Links, screenshots, or examples.

.github/pull_request_template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Summary
2+
3+
Describe what changed and why.
4+
5+
## Changes
6+
7+
-
8+
9+
## Validation
10+
11+
- [ ] `npm run test:all`
12+
- [ ] `npm run test:smoke:extension` (if extension runtime behavior changed)
13+
- [ ] `npm run test:flows:extension` (if navigation/state transitions changed)
14+
15+
## Screenshots / Evidence
16+
17+
If UI or behavior changed, include screenshots or artifact paths.
18+
19+
## Checklist
20+
21+
- [ ] Tests added/updated where needed
22+
- [ ] Documentation updated where needed
23+
- [ ] No unrelated changes included

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
Thanks for contributing to Chrome Activity Reader.
4+
5+
## Development Setup
6+
7+
1. Install Node.js 22+
8+
2. Install dependencies:
9+
- `npm install`
10+
3. Install Playwright browser:
11+
- `npx playwright install chromium`
12+
13+
## Run Tests
14+
15+
- `npm run test:all`
16+
- `npm run test:smoke:extension`
17+
- `npm run test:flows:extension`
18+
19+
## Pull Request Guidelines
20+
21+
1. Keep changes focused and small.
22+
2. Add or update tests for behavior changes.
23+
3. Update docs when user-facing behavior changes.
24+
4. Ensure all tests pass before opening PR.
25+
26+
## Commit Message Style
27+
28+
Use clear imperative messages, for example:
29+
30+
- `Fix side panel state sync after close`
31+
- `Add install guide for unpacked Chrome extension`

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Baboonzero
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Chrome extension that tracks all web tabs (`http/https`) and surfaces attention-
55
For complete project history, architecture decisions, execution timeline, built/not-built scope, and current status, see:
66
- `project-history.md`
77
- `docs/INSTALLATION.md`
8+
- `docs/GITHUB_METADATA.md`
89

910
## Features
1011

@@ -121,3 +122,11 @@ If `default` session fails to start on Windows, use a non-default `--session` na
121122

122123
- Tracking scope is web tabs only (`http/https`), not `chrome://` or extension pages.
123124
- No content-script capture of in-page click/typing/scroll behavior.
125+
126+
## License
127+
128+
MIT - see `LICENSE`.
129+
130+
## Contributing
131+
132+
See `CONTRIBUTING.md`.

docs/GITHUB_METADATA.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# GitHub Metadata and Repo Polish
2+
3+
Use this file as the source of truth for GitHub repository settings.
4+
5+
## Recommended Repository Description
6+
7+
`Chrome extension (MV3) that tracks tab activity across windows and surfaces meaningful work over 1h, 4h, 1d, and 7d with side-panel and dashboard views.`
8+
9+
## Recommended Topics
10+
11+
Add these topics in GitHub:
12+
13+
- `chrome-extension`
14+
- `manifest-v3`
15+
- `productivity`
16+
- `tab-management`
17+
- `activity-tracker`
18+
- `browser-extension`
19+
- `playwright`
20+
- `automation-testing`
21+
- `javascript`
22+
- `indexeddb`
23+
24+
## Suggested Website/Homepage
25+
26+
If you do not have a marketing site, set homepage to:
27+
28+
`https://github.com/baboonzero/chrome-activity-reader`
29+
30+
## Recommended Social Preview
31+
32+
Use a 1280x640 image that includes:
33+
34+
- App name: `Chrome Activity Reader`
35+
- Tagline: `Track everything. Surface what matters.`
36+
- Visual cue: side panel + dashboard split mockup
37+
38+
## Labels To Add (Issues/PR Triage)
39+
40+
- `bug`
41+
- `enhancement`
42+
- `documentation`
43+
- `good first issue`
44+
- `help wanted`
45+
- `needs reproduction`
46+
- `priority:high`
47+
- `priority:medium`
48+
- `priority:low`
49+
- `testing`
50+
51+
## Current Defaults Added In This Repo
52+
53+
- MIT license (`LICENSE`)
54+
- Pull request template (`.github/pull_request_template.md`)
55+
- Issue templates (`.github/ISSUE_TEMPLATE/*.yml`)
56+
- Contributing guide (`CONTRIBUTING.md`)

package.json

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,16 @@
1313
"test:validate:long": "node scripts/long-duration-extension-validation.mjs",
1414
"test:all": "npm run test:unit && npm run test:e2e"
1515
},
16-
"keywords": [],
17-
"author": "",
18-
"license": "ISC",
16+
"keywords": [
17+
"chrome-extension",
18+
"mv3",
19+
"tab-tracking",
20+
"activity-tracker",
21+
"productivity",
22+
"playwright"
23+
],
24+
"author": "Baboonzero",
25+
"license": "MIT",
1926
"devDependencies": {
2027
"@playwright/test": "^1.58.2",
2128
"fake-indexeddb": "^6.2.5",

project-history.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,17 @@ Chronological execution log:
224224
- added dedicated guide: `docs/INSTALLATION.md`
225225
- updated project documentation status and validation references
226226

227+
39. Added open-source licensing and GitHub collaboration polish:
228+
- added MIT license (`LICENSE`)
229+
- aligned package metadata to MIT in `package.json`
230+
- added GitHub metadata guidance (`docs/GITHUB_METADATA.md`) with description/topics
231+
- added contribution/collaboration scaffolding:
232+
- `CONTRIBUTING.md`
233+
- `.github/pull_request_template.md`
234+
- `.github/ISSUE_TEMPLATE/bug_report.yml`
235+
- `.github/ISSUE_TEMPLATE/feature_request.yml`
236+
- `.github/ISSUE_TEMPLATE/config.yml`
237+
227238
## 4. What Were The Decisions That We Took?
228239

229240
### Product/Architecture Decisions
@@ -327,6 +338,8 @@ Not in MVP (intentionally out of scope):
327338
- CI workflow: **configured**
328339
- Manual acceptance assets: **present**
329340
- End-user installation guide: **present**
341+
- Open-source license (MIT): **present**
342+
- GitHub collaboration templates: **present**
330343
- Headed long-duration runtime validation with artifacts: **complete**
331344
- Side panel + all-tab model rollout: **complete**
332345
- Repo pushed to GitHub: **yes**
@@ -356,6 +369,7 @@ Primary commits:
356369
- `c59d30f` Add long-duration extension validation with screenshot evidence
357370
- `6ac346b` Document headed long-run validation and agent-browser evidence
358371
- `5ba01b2` Remove redundant Most recent view filter
372+
- `c6935f3` Complete docs and add clear extension install guide
359373

360374
## 9. File-Level Map Of What Exists
361375

@@ -405,6 +419,8 @@ Primary commits:
405419
- `README.md` (quick start)
406420
- `project-history.md` (this full build document)
407421
- `docs/INSTALLATION.md`
422+
- `docs/GITHUB_METADATA.md`
423+
- `CONTRIBUTING.md`
408424
- `docs/APPROACH_AND_PLAN.md`
409425
- `docs/plans/2026-02-26-chrome-activity-reader-design.md`
410426
- `docs/plans/2026-02-26-chrome-activity-reader-implementation-plan.md`
@@ -416,6 +432,10 @@ Primary commits:
416432
### Operations
417433

418434
- `.github/workflows/ci.yml`
435+
- `.github/pull_request_template.md`
436+
- `.github/ISSUE_TEMPLATE/bug_report.yml`
437+
- `.github/ISSUE_TEMPLATE/feature_request.yml`
438+
- `.github/ISSUE_TEMPLATE/config.yml`
419439
- `scripts/extension-flow-matrix-test.mjs`
420440
- `scripts/manual-acceptance.ps1`
421441
- `package.json`

0 commit comments

Comments
 (0)