Skip to content

Commit 9aa68e5

Browse files
Ring-wdrRing-wdr
committed
Prepare repository for public launch
1 parent 8dc91a1 commit 9aa68e5

10 files changed

Lines changed: 288 additions & 0 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Ring-wdr

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug report
2+
description: Report a reproducible bug in react-devtool-cli
3+
title: "[Bug] "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Please reduce the report to a minimal reproduction. Environment-sensitive bugs need exact versions and commands.
11+
- type: input
12+
id: version
13+
attributes:
14+
label: react-devtool-cli version
15+
description: Output of `rdt --version`
16+
placeholder: 0.1.34
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: environment
21+
attributes:
22+
label: Environment
23+
description: OS, Node.js, browser, React version, app stack, and transport mode
24+
placeholder: |
25+
Windows 11
26+
Node.js 22.11.0
27+
Chromium via session open
28+
Next.js 16 + React 19
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: reproduction
33+
attributes:
34+
label: Reproduction steps
35+
description: Exact commands and steps to reproduce
36+
placeholder: |
37+
1. rdt session open ...
38+
2. rdt profiler start ...
39+
3. rdt interact click ...
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: observed
44+
attributes:
45+
label: Observed behavior
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: Expected behavior
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: notes
56+
attributes:
57+
label: Additional context
58+
description: Logs, screenshots, runtime warnings, or anything that narrows the issue

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Usage and command semantics
4+
url: https://github.com/Ring-wdr/react-devtool-cli/blob/main/README.md
5+
about: Check the README for supported workflows and response semantics before opening an issue.
6+
- name: Contribution guide
7+
url: https://github.com/Ring-wdr/react-devtool-cli/blob/main/CONTRIBUTING.md
8+
about: Read the maintainer model and contribution expectations before opening feature requests or pull requests.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature request
2+
description: Propose a focused improvement to react-devtool-cli
3+
title: "[Feature] "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This project is maintained by one person. Please describe the user problem and why it belongs in the CLI surface.
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem statement
15+
description: What user task is blocked or made harder today?
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: proposal
20+
attributes:
21+
label: Proposed change
22+
description: Describe the command, output shape, or workflow change you want
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: alternatives
27+
attributes:
28+
label: Alternatives considered
29+
description: Existing commands, scripting, or workarounds you tried
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: maintenance
34+
attributes:
35+
label: Maintenance tradeoffs
36+
description: Why should this be maintained in-core rather than documented as an external workflow?

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Summary
2+
3+
- describe the change
4+
- link the issue if there is one
5+
6+
## Validation
7+
8+
- [ ] `npm run build`
9+
- [ ] `npm test`
10+
- [ ] README or docs updated when behavior changed
11+
12+
## Maintainer Notes
13+
14+
- Keep the PR focused.
15+
- Call out any follow-up work explicitly instead of bundling it into this change.

‎.github/workflows/ci.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
workflow_dispatch:
11+
12+
jobs:
13+
test:
14+
name: Node 22 on ${{ matrix.os }}
15+
runs-on: ${{ matrix.os }}
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
os:
20+
- ubuntu-latest
21+
- windows-latest
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
26+
- name: Setup Node.js
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: 22
30+
cache: npm
31+
32+
- name: Install dependencies
33+
run: npm ci
34+
35+
- name: Build
36+
run: npm run build
37+
38+
- name: Test
39+
run: npm test

‎CONTRIBUTING.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing
2+
3+
Thanks for contributing to `react-devtool-cli`.
4+
5+
## Maintainer Model
6+
7+
- This repository is maintained by one person.
8+
- Review, triage, and releases happen on a best-effort basis.
9+
- The bar for accepting new surface area is intentionally high. Features that increase long-term maintenance cost without clear user value may be declined.
10+
11+
## Before Opening An Issue
12+
13+
- Confirm you are on the latest published version.
14+
- Read the current `README.md` and command semantics carefully.
15+
- Reduce the report to a minimal, reproducible command sequence.
16+
- Include concrete environment details:
17+
- `rdt --version`
18+
- OS and Node.js version
19+
- browser / transport mode
20+
- React version and app stack
21+
22+
## Good Issue Reports
23+
24+
- Bug reports should include exact commands, observed output, expected behavior, and whether the behavior is stable or intermittent.
25+
- Feature requests should describe the user problem first, not just the proposed flag or command shape.
26+
- Documentation issues should point to the exact section that is wrong, ambiguous, or outdated.
27+
28+
## Pull Requests
29+
30+
- Open an issue first for non-trivial behavior changes.
31+
- Keep changes narrowly scoped.
32+
- Add or update tests when behavior changes.
33+
- Preserve the CLI's bias toward deterministic, structured output.
34+
- Do not bundle unrelated refactors into the same PR.
35+
36+
## Development
37+
38+
```bash
39+
npm ci
40+
npm run build
41+
npm test
42+
```
43+
44+
## What To Expect
45+
46+
- Small bug fixes and documentation improvements are the easiest to review.
47+
- Large feature PRs may sit until there is a clear maintenance story.
48+
- Stale issues or PRs may be closed if they cannot be reproduced or do not have enough detail to act on.

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ Published package notes:
2424
- npm consumers receive built files from `dist/`, not the repository source tree.
2525
- repository-only validation artifacts, handoff docs, and local test fixtures are intentionally excluded from the published package.
2626

27+
## Public Repository Expectations
28+
29+
- This project is maintained by a single maintainer.
30+
- Issues, PRs, and releases are handled on a best-effort basis with no response SLA.
31+
- Reproducible bug reports and narrowly scoped feature proposals are much more likely to be actioned than open-ended support requests.
32+
- Before opening a PR or issue, read [CONTRIBUTING.md](./CONTRIBUTING.md) and [SECURITY.md](./SECURITY.md).
33+
- Maintainer operating principles for the public repo are documented in [docs/public-repo-strategy.md](./docs/public-repo-strategy.md).
34+
2735
`rdt` resolves Playwright in this order:
2836

2937
- local `playwright`

‎SECURITY.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Security fixes are provided on a best-effort basis for the latest published release line only.
6+
7+
| Version | Supported |
8+
| ------- | --------- |
9+
| Latest `0.1.x` | Yes |
10+
| Older versions | No |
11+
12+
## Reporting A Vulnerability
13+
14+
- Do not open a public issue for a suspected security vulnerability.
15+
- If GitHub private vulnerability reporting is enabled for this repository, use it.
16+
- Otherwise, contact the maintainer through GitHub before public disclosure and include:
17+
- affected version
18+
- impact summary
19+
- reproduction details
20+
- any suggested remediation
21+
22+
The maintainer will triage reports on a best-effort basis. There is no guaranteed response time.

‎docs/public-repo-strategy.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Public Repository Strategy
2+
3+
This repository is run as a solo-maintainer open source project. The operating model is deliberately simple so the project can stay useful without creating an unsustainable review and support burden.
4+
5+
## 1. Scope Control
6+
7+
- Keep the public API small and explicit.
8+
- Favor commands and response fields that are deterministic and agent-friendly.
9+
- Treat feature requests as proposals, not commitments.
10+
- Prefer documentation and diagnostics over adding new flags when the same user problem can be solved with clearer workflows.
11+
12+
## 2. Triage Model
13+
14+
- Bugs with a minimal reproduction get first priority.
15+
- Regressions in existing CLI behavior outrank new feature work.
16+
- Windows, Node, React, and Playwright version details are required for environment-sensitive reports.
17+
- Issues without enough detail to reproduce may be closed after follow-up.
18+
19+
## 3. Release Strategy
20+
21+
- Keep releases small and incremental.
22+
- Require a green CI run plus local maintainer confidence before publishing.
23+
- Prefer shipping focused fixes quickly over batching unrelated changes into larger releases.
24+
- When behavior changes materially, update `README.md` in the same change.
25+
26+
## 4. Contribution Policy
27+
28+
- Accept bug fixes, docs improvements, and narrowly scoped maintainability improvements most readily.
29+
- Review larger features only when the long-term maintenance cost is clear and acceptable.
30+
- Use squash merges to keep history readable.
31+
- Delete merged branches to reduce repository clutter.
32+
33+
## 5. Support Boundary
34+
35+
- The repository is not a general consulting channel for Playwright, React DevTools internals, or app-specific performance debugging.
36+
- Best-effort support is limited to the CLI's documented behavior.
37+
- Non-actionable support requests should be redirected toward reproducible issues or clearer documentation gaps.
38+
39+
## 6. Automation Baseline
40+
41+
- Run CI on push and pull request for the default branch.
42+
- Validate the build and test suite on both Linux and Windows because session/runtime behavior can be platform-sensitive.
43+
- Keep automation intentionally lightweight; avoid adding bots that create more inbox traffic than value.
44+
45+
## 7. Repository Defaults
46+
47+
- Public visibility
48+
- Issues enabled
49+
- Wiki disabled
50+
- Projects disabled
51+
- Discussions disabled unless issue volume justifies a separate support channel
52+
- Secret scanning enabled when available
53+
- Topic metadata kept current so the repo is discoverable without overselling scope

0 commit comments

Comments
 (0)