Skip to content

Commit 490a663

Browse files
authored
docs: license pack, public agent guides, community templates (#105)
## Summary Phase A of the OSS-ready program (approved plan, 7 Codex review rounds): adds the repository's licensing posture and rewrites the public contributor surface. - **LICENSE**: official PolyForm Noncommercial 1.0.0 text with the Required Notice line — code is free for noncommercial use; commercial use requires a separate license. - **NOTICE**: separates first-party excluded assets (all rights reserved) from third-party materials governed by their own embedded terms (fonts, the four proprietary skills, the shared office tree); nominative-use statement; commercial contact. - **29 manifests** gain `license` fields; root description now says *source-available*; the five skills that claimed MIT now carry the repository license. - **AGENTS.md** rewritten from scratch as the canonical public contributor/agent guide (agents.md convention) — stack, layout, gates, house naming contracts, BYOK and DB-role boundaries, migration safety, neutral verification policy. All private operator prose removed. **CLAUDE.md** is now a thin `@AGENTS.md` import. - **Community files**: Contributor Covenant 2.1, bug/feature issue forms, PR template with a verification-notes checklist. - One UI comment reworded to describe its real constraint. ## Verification notes - [x] `pnpm lint` - [x] `pnpm typecheck` - [x] `pnpm turbo build --force` - [x] `pnpm deadcode` - [x] `pnpm architecture:check` - [x] `pnpm turbo skills:build` Docs-only + comment reword + manifest metadata: no runtime behavior changes, so no browser QA applies. LICENSE body verified against the official polyformproject.org plain text (wrap-insensitive match); every path asserted in AGENTS.md verified to exist.
1 parent b25b97d commit 490a663

43 files changed

Lines changed: 709 additions & 381 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug report
2+
description: Report a reproducible problem with Cheatcode
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to report a problem. Please avoid including credentials, provider keys, or other sensitive data.
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: What happened?
15+
description: Describe the problem and what you expected to happen.
16+
placeholder: A clear, concise description of the problem.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: reproduction
21+
attributes:
22+
label: Steps to reproduce
23+
description: Give the smallest reliable sequence that reproduces the problem.
24+
placeholder: |
25+
1. Go to ...
26+
2. Select ...
27+
3. Observe ...
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: environment
32+
attributes:
33+
label: Environment
34+
description: Include the browser, operating system, Node.js version, and deployment context when relevant.
35+
placeholder: Chrome 140, macOS 16, Node.js 24.18.0, local development
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: additional-context
40+
attributes:
41+
label: Additional context
42+
description: Add sanitized logs, screenshots, or other details that may help diagnose the problem.
43+
- type: checkboxes
44+
id: checks
45+
attributes:
46+
label: Before submitting
47+
options:
48+
- label: I searched existing issues for the same problem.
49+
required: true
50+
- label: I removed credentials, provider keys, and other sensitive data from this report.
51+
required: true
52+
- label: I agree to follow this repository's Code of Conduct.
53+
required: true
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Feature request
2+
description: Suggest an improvement for Cheatcode
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for helping improve Cheatcode. Explain the user need before proposing implementation details.
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem or opportunity
15+
description: What user need, limitation, or opportunity should this change address?
16+
placeholder: Describe who is affected and why the current experience is insufficient.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: proposal
21+
attributes:
22+
label: Proposed outcome
23+
description: Describe the behavior or outcome you would like to see.
24+
placeholder: A clear, concise description of the desired result.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: alternatives
29+
attributes:
30+
label: Alternatives considered
31+
description: Share workarounds or alternative approaches you considered.
32+
- type: textarea
33+
id: additional-context
34+
attributes:
35+
label: Additional context
36+
description: Add mockups, examples, or related links. Do not include credentials or sensitive data.
37+
- type: checkboxes
38+
id: checks
39+
attributes:
40+
label: Before submitting
41+
options:
42+
- label: I searched existing issues for a similar request.
43+
required: true
44+
- label: I agree to follow this repository's Code of Conduct.
45+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Summary
2+
3+
<!-- Explain what changed, why it changed, and any relevant issue or architectural decision. -->
4+
5+
## Verification notes
6+
7+
<!-- Mark every gate you ran. If a gate is not applicable, explain why. -->
8+
9+
- [ ] `pnpm lint`
10+
- [ ] `pnpm typecheck`
11+
- [ ] `pnpm turbo build --force`
12+
- [ ] `pnpm deadcode`
13+
- [ ] `pnpm architecture:check`
14+
- [ ] `pnpm turbo skills:build`
15+
16+
<!-- For behavior changes, describe the real user flow exercised through direct browser QA and summarize console, network, and application-log review. If browser QA is not applicable, say why. -->

0 commit comments

Comments
 (0)