diff options
| author | amankumarsingh77 <amankumarsingh7702@gmal.com> | 2026-05-02 00:08:22 +0530 |
|---|---|---|
| committer | amankumarsingh77 <amankumarsingh7702@gmal.com> | 2026-05-02 00:08:22 +0530 |
| commit | ae22379668b34cde6f0ce8e5ad0bc5ec98934852 (patch) | |
| tree | 2317ba0d0b42f4212a0970b29d068b5b1429ab2e /.github | |
| parent | 28578d1d6237cdec3f613a3ed9fa6e888dd71a6b (diff) | |
chore: prepare v0.1.0 release
- Add hero image for pi package gallery
- Update CHANGELOG with release date
- Update README with npm install instructions
- Add assets/ to npm package files
- Add CONTRIBUTING.md and GitHub templates
- Add CI workflow for typecheck and pack validation
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 40 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 23 | ||||
| -rw-r--r-- | .github/pull_request_template.md | 29 | ||||
| -rw-r--r-- | .github/workflows/ci.yml | 36 |
4 files changed, 128 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..87023dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug report +about: Report a reproducible problem with pi-browser-harness +title: "[Bug]: " +labels: bug +assignees: "" +--- + +## Description + +Describe the problem clearly. Include what browser action or pi tool failed, if applicable. + +## Steps to Reproduce + +1. +2. +3. + +Please include the exact prompt, command, or tool call sequence when possible. + +## Expected Behavior + +What did you expect to happen? + +## Actual Behavior + +What happened instead? Include error messages, screenshots, or relevant logs if available. + +## Environment + +- OS: +- Node version (`node --version`): +- Chrome / Chromium / Edge version: +- pi version: +- pi-browser-harness version or commit: +- Install method (`npm`, `git`, local path): + +## Additional Context + +Add any other context that may help diagnose the issue, such as whether Chrome remote debugging was enabled through `chrome://inspect/#remote-debugging` or launched with `--remote-debugging-port=9222`. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..4944eed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an improvement or new browser-control capability +title: "[Feature]: " +labels: enhancement +assignees: "" +--- + +## Problem Statement + +What problem are you trying to solve? Describe the workflow, limitation, or browser-control gap. + +## Proposed Solution + +Describe the behavior you would like to see. If this is a new browser tool, include the proposed `browser_*` name, inputs, and expected output if you have a preference. + +## Alternatives Considered + +What alternatives or workarounds have you tried? For example, could this be handled with `browser_execute_js`, `browser_http_get`, or `browser_run_script` today? + +## Additional Context + +Add examples, screenshots, links, or related Chrome DevTools Protocol details that would help explain the request. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..860a961 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ +## Description + +Describe what this PR changes and why. Include user-facing behavior changes, new browser tools, or documentation updates. + +## Related Issue + +Closes # + +## Type of Change + +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Refactor or maintenance +- [ ] Release or packaging change +- [ ] Other: + +## Testing + +Describe how you tested the change. Include local pi install steps or browser workflows when relevant. + +## Checklist + +- [ ] I ran `npm run typecheck`. +- [ ] I ran `npm pack --dry-run` or otherwise verified packaging when package contents changed. +- [ ] I tested locally with `pi install /path/to/pi-browser-harness` when runtime behavior changed. +- [ ] I updated README documentation for user-facing changes. +- [ ] I updated CHANGELOG.md for user-facing changes. +- [ ] I kept the change focused and avoided unrelated rewrites. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..59d202d --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,36 @@ +name: CI + +on: + push: + branches: + - main + pull_request: + branches: + - main + +permissions: + contents: read + +jobs: + typecheck-and-pack: + name: Typecheck and package + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: 22 + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Typecheck + run: npm run typecheck + + - name: Verify npm package + run: npm pack --dry-run |
