diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..51c6d1b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug report +about: Something is broken +labels: bug +--- + +**What happened** + +**What you expected** + +**Steps to reproduce** + +1. + +**Environment** + +- OS / platform: +- Version or commit: + +**Logs / screenshots** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..04c00dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,11 @@ +--- +name: Feature request +about: Suggest an idea +labels: enhancement +--- + +**Problem this solves** + +**Proposed solution** + +**Alternatives considered** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..8a79ef4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +## What + +## Why + +## How it was tested + +- [ ] Existing tests pass +- [ ] New behavior is covered by a test (or explain why not) +- [ ] Docs updated if behavior changed (README/CONTRIBUTING) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..e3ab24d --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,21 @@ +name: CI + +on: + push: + branches: [main] + pull_request: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: "3.12" + - name: Install check tools + run: pip install black pytest + - name: Format check + run: black --check scribe tests + - name: Unit tests (pure-Python modules only, no GPU) + run: python -m pytest tests -q diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..2746f3b --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,18 @@ +# Security Policy + +## Supported versions + +Only the latest release (or the tip of the default branch, if unreleased) +receives security fixes. + +## Reporting a vulnerability + +Please do NOT open a public issue for security problems. + +- Preferred: use GitHub's private vulnerability reporting on this repo + (Security tab, "Report a vulnerability"). +- Or email: contact@jay739.dev + +You can expect an acknowledgement within a few days. Please include steps to +reproduce and the impact you believe the issue has. Credit is given in the fix +release notes unless you prefer otherwise.