Skip to content

Commit 5ccbfe8

Browse files
Polish public repository docs and CI
1 parent 02b127e commit 5ccbfe8

6 files changed

Lines changed: 108 additions & 1 deletion

File tree

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Bug report
3+
about: Report a reproducible problem
4+
title: "[Bug]: "
5+
labels: bug
6+
---
7+
8+
## What happened?
9+
10+
## Steps to reproduce
11+
1.
12+
2.
13+
3.
14+
15+
## Expected behavior
16+
17+
## Environment
18+
- OS:
19+
- Version/commit:
20+
21+
## Logs or screenshots
22+
Remove secrets before pasting logs.

.github/pull_request_template.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Summary
2+
3+
## Validation
4+
- [ ] Tests/checks run
5+
- [ ] Documentation updated
6+
- [ ] No secrets committed
7+
8+
## Screenshots / notes

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## Unreleased
6+
7+
- Added repository polish: security policy, contribution workflow, CI baseline, and clearer documentation structure.
8+
9+
## Initial Public Version
10+
11+
- Published the first public project version.

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Setupr
22

3+
> AI-powered CLI that detects project stacks, plans setup, installs dependencies, configures environments, and verifies local health.
4+
5+
![Status](https://img.shields.io/badge/status-beta-6b7280) ![License](https://img.shields.io/github/license/Evan1108-Coder/Setupr) ![CI](https://img.shields.io/github/actions/workflow/status/Evan1108-Coder/Setupr/ci.yml?branch=main&label=CI)
6+
7+
**TypeScript CLI • stack detection • setup automation • project doctor**
8+
9+
## At a Glance
10+
11+
- Real project documentation now includes security, contribution, changelog, CI, and issue/PR workflows.
12+
- Maintenance snapshot: see [docs/project-snapshot.md](docs/project-snapshot.md) for a generated file-mix chart and repository checklist.
13+
- Public repo: https://github.com/Evan1108-Coder/Setupr
14+
15+
---
16+
317
> Status: beta. Setupr is usable as a CLI today, but some stack-specific setup paths still need more real-world testing.
418
519
Setupr is for developers who clone projects often and do not want to manually guess install commands, runtime versions, environment files, ports, or verification steps.
@@ -124,4 +138,4 @@ Project-level config via `.setupr.json`:
124138

125139
## License
126140

127-
MIT
141+
MIT

SECURITY.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Security fixes are handled on the default branch unless a release branch is explicitly listed.
6+
7+
## Reporting a Vulnerability
8+
9+
Please do not open a public issue for a suspected vulnerability. Email the maintainer or use GitHub's private vulnerability reporting when available. Include:
10+
11+
- Affected version or commit
12+
- Steps to reproduce
13+
- Impact and likelihood
14+
- Any relevant logs with secrets removed
15+
16+
## Secret Handling
17+
18+
Never commit API keys, Telegram tokens, OAuth credentials, database files, `.env` files, or local user exports. Use `.env.example` for placeholders only.

docs/project-snapshot.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Project Snapshot
2+
3+
Generated from the repository tree for public README/maintenance polish. Counts exclude `.git`, dependency folders, and build outputs.
4+
5+
## File Mix
6+
7+
- TypeScript: 114 files (71%)
8+
- TSX: 28 files (17%)
9+
- Markdown: 11 files (7%)
10+
- JSON: 7 files (4%)
11+
- JavaScript: 1 files (1%)
12+
13+
```mermaid
14+
pie title Source/documentation file mix
15+
"JavaScript" : 1
16+
"TypeScript" : 114
17+
"TSX" : 28
18+
"Markdown" : 11
19+
"JSON" : 7
20+
```
21+
22+
## Maintenance Checklist
23+
24+
- README describes purpose, setup, and limitations.
25+
- CI runs baseline install/test/build checks where applicable.
26+
- SECURITY.md explains vulnerability and secret handling.
27+
- CHANGELOG.md tracks public changes.
28+
- Issue and PR templates are available.
29+
30+
## Real Test Snapshot
31+
32+
- `npm test -- --runInBand` completed successfully on 2026-06-08.
33+
- Current suite footprint: 28 Vitest files / 3,555 test lines under `tests/`.
34+
- Coverage areas visible from filenames: auth, environment handling, dependency intelligence, git intelligence, TUI, setup flow, plugins, scanner, memory, and verification security.

0 commit comments

Comments
 (0)