Skip to content

Commit 4769b7d

Browse files
committed
Add repo maintenance automation
1 parent 9db37ce commit 4769b7d

8 files changed

Lines changed: 176 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+
* @Boyeep
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Bug Report
2+
description: Report a bug in the starter kit or its developer workflow.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Summary
11+
description: What is going wrong?
12+
placeholder: A short description of the bug.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: steps
18+
attributes:
19+
label: Reproduction
20+
description: How can someone reproduce the issue?
21+
placeholder: |
22+
1. Go to ...
23+
2. Run ...
24+
3. Upload ...
25+
4. Observe ...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: expected
31+
attributes:
32+
label: Expected Behavior
33+
description: What should have happened instead?
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: environment
39+
attributes:
40+
label: Environment
41+
description: Include OS, Node version, Python version, and anything else relevant.
42+
placeholder: Windows 11, Node 22, Python 3.12, Docker Desktop off, etc.
43+
validations:
44+
required: false
45+
46+
- type: textarea
47+
id: logs
48+
attributes:
49+
label: Logs or Screenshots
50+
description: Paste any helpful logs, stack traces, or screenshots.
51+
validations:
52+
required: false

.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: Security report
4+
url: https://github.com/Boyeep/nextjs-python-computer-vision-kit/security/advisories/new
5+
about: Please report sensitive security issues privately.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Feature Request
2+
description: Propose a new capability or improvement for the template.
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: Problem
11+
description: What problem would this solve for users of the repo?
12+
placeholder: The starter currently lacks ...
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: proposal
18+
attributes:
19+
label: Proposed Solution
20+
description: Describe the improvement you want to see.
21+
validations:
22+
required: true
23+
24+
- type: dropdown
25+
id: area
26+
attributes:
27+
label: Area
28+
options:
29+
- Frontend
30+
- Backend
31+
- API contract
32+
- CI/CD
33+
- Docs
34+
- Docker / deployment
35+
- Developer workflow
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: notes
41+
attributes:
42+
label: Extra Context
43+
description: Links, mockups, tradeoffs, or implementation notes.
44+
validations:
45+
required: false

.github/dependabot.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
8+
- package-ecosystem: "npm"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"
12+
13+
- package-ecosystem: "npm"
14+
directory: "/frontend"
15+
schedule:
16+
interval: "weekly"
17+
18+
- package-ecosystem: "pip"
19+
directory: "/backend"
20+
schedule:
21+
interval: "weekly"

.github/pull_request_template.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Summary
2+
3+
- what changed
4+
- why it changed
5+
6+
## Verification
7+
8+
- [ ] `npm run check:contract`
9+
- [ ] `npm run check`
10+
- [ ] `npm run check:images` if Docker was available
11+
12+
## Contract Impact
13+
14+
- [ ] no API contract changes
15+
- [ ] updated `docs/openapi.yaml`
16+
- [ ] ran `npm run api:types`
17+
- [ ] updated frontend usage of generated types
18+
19+
## Screenshots or Notes
20+
21+
Add UI screenshots, API examples, or rollout notes if they help reviewers.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ It gives you a polished upload-to-inference UI, a typed OpenAPI contract, CPU-fr
99
<a href="#screenshots">Screenshots</a> ·
1010
<a href="#what-you-get">What you get</a> ·
1111
<a href="./CONTRIBUTING.md">Contributing</a> ·
12+
<a href="./SECURITY.md">Security</a> ·
1213
<a href="./soon.md">Roadmap</a>
1314
</p>
1415

@@ -71,6 +72,7 @@ These pipelines are intentionally lightweight. They prove the repo shape and dev
7172
- `docs/`: OpenAPI contract and screenshot assets
7273
- `scripts/`: root development and verification commands
7374
- `.github/`: template CI workflow
75+
- `SECURITY.md`: vulnerability reporting guidance
7476

7577
## Quick Start
7678

SECURITY.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
This repository is a starter template, so security fixes are generally applied to the
6+
latest version on `main`.
7+
8+
## Reporting A Vulnerability
9+
10+
Please do not open a public issue for sensitive security reports.
11+
12+
Use GitHub security advisories for private disclosure:
13+
14+
`https://github.com/Boyeep/nextjs-python-computer-vision-kit/security/advisories/new`
15+
16+
If the issue is not sensitive and is more of a hardening or best-practice improvement,
17+
you can open a normal issue instead.
18+
19+
## Scope Notes
20+
21+
Useful reports include:
22+
23+
- dependency vulnerabilities in the shipped template
24+
- insecure default configuration in frontend, backend, or Docker files
25+
- unsafe upload handling or API behavior
26+
- secrets exposure in docs, scripts, or CI
27+
28+
Reports that depend entirely on downstream customizations may still be useful, but they
29+
may be treated as template hardening suggestions rather than direct vulnerabilities.

0 commit comments

Comments
 (0)