Initialize League GUI prototype
This commit is contained in:
38
docs/agent-handoff.md
Normal file
38
docs/agent-handoff.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Agent Handoff
|
||||
|
||||
Use this file when a task spans multiple sessions, has unresolved follow-up work, or changes release behavior.
|
||||
|
||||
## Current State
|
||||
|
||||
```text
|
||||
Codex Agent Repository Kit baseline applied. The project is a React/Vite/TypeScript prototype with npm scripts for development, build, and tests.
|
||||
```
|
||||
|
||||
## Changes Made
|
||||
|
||||
- Added agent instructions and project notes.
|
||||
- Added security, contribution, changelog, release checklist, security review, and release notes documents.
|
||||
- Added non-destructive Gitea maintenance workflows.
|
||||
- Project remote set to `https://git.wilkensxl.de/Toxic/league-of-legends-gui-overhaul.git`.
|
||||
- Documented current npm build and test commands.
|
||||
|
||||
## Verification
|
||||
|
||||
| Check | Result |
|
||||
| --- | --- |
|
||||
| `git diff --check` | PENDING |
|
||||
|
||||
## Open Questions
|
||||
|
||||
- Separate lint, audit, and release-check scripts.
|
||||
- Release packaging and download target.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Add separate lint, audit, and release-check scripts if needed.
|
||||
- Add or update build workflow around `npm run build` and `npm test`.
|
||||
- Update README, `AGENTS.md`, `.codex/project.md`, and release docs when implementation begins.
|
||||
|
||||
## Risks
|
||||
|
||||
- Release packaging is intentionally limited until download targets are defined.
|
||||
38
docs/release-checklist.md
Normal file
38
docs/release-checklist.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Release Checklist
|
||||
|
||||
No release process exists yet. Complete this checklist only after the project has real build, test, audit, and artifact commands.
|
||||
|
||||
## Version
|
||||
|
||||
- [ ] Version number updated.
|
||||
- [ ] Changelog updated.
|
||||
- [ ] README updated.
|
||||
|
||||
## Quality
|
||||
|
||||
- [ ] Working tree is clean.
|
||||
- [ ] Lint or type checks pass.
|
||||
- [ ] Tests pass or missing tests are documented.
|
||||
- [ ] Build succeeds in CI.
|
||||
|
||||
## Security
|
||||
|
||||
- [ ] Security review is current.
|
||||
- [ ] Dependency audit is clean or documented.
|
||||
- [ ] No secrets are committed.
|
||||
- [ ] Release artifacts do not contain local config files.
|
||||
|
||||
## Artifacts
|
||||
|
||||
- [ ] Artifacts are produced by documented commands.
|
||||
- [ ] Artifacts are uploaded.
|
||||
- [ ] Download links work.
|
||||
- [ ] Package registry links work if used.
|
||||
- [ ] Installer, portable, or archive naming is clear.
|
||||
|
||||
## Release
|
||||
|
||||
- [ ] Git tag created.
|
||||
- [ ] Release notes written.
|
||||
- [ ] Release published.
|
||||
- [ ] Post-release download smoke test completed.
|
||||
25
docs/release-notes.md
Normal file
25
docs/release-notes.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# League of Legends GUI Overhaul PENDING
|
||||
|
||||
## Downloads
|
||||
|
||||
No release artifacts exist yet.
|
||||
|
||||
## Highlights
|
||||
|
||||
- Codex Agent Repository Kit baseline applied.
|
||||
|
||||
## Security
|
||||
|
||||
- Dependency audit: pending until dependencies exist.
|
||||
- Secret handling: secrets must not be committed.
|
||||
- External network calls: pending until implementation exists.
|
||||
|
||||
## Verification
|
||||
|
||||
| Check | Result |
|
||||
| --- | --- |
|
||||
| `git diff --check` | PENDING |
|
||||
|
||||
## Notes
|
||||
|
||||
Release notes are a placeholder until the project has a releasable artifact.
|
||||
54
docs/security-review.md
Normal file
54
docs/security-review.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Security Review
|
||||
|
||||
## Scope
|
||||
|
||||
Project:
|
||||
|
||||
```text
|
||||
League of Legends GUI Overhaul
|
||||
```
|
||||
|
||||
Reviewed version or commit:
|
||||
|
||||
```text
|
||||
PENDING
|
||||
```
|
||||
|
||||
## Code Patterns Checked
|
||||
|
||||
- [ ] No `eval`.
|
||||
- [ ] No dynamic `Function` constructor.
|
||||
- [ ] No unsafe HTML injection.
|
||||
- [ ] No unexpected shell execution.
|
||||
- [ ] No unexpected external network calls.
|
||||
- [ ] No secrets committed.
|
||||
- [ ] No unsafe file writes outside expected user-selected paths.
|
||||
|
||||
## Dependency Review
|
||||
|
||||
Command:
|
||||
|
||||
```text
|
||||
PENDING
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```text
|
||||
No dependency audit exists yet because no implementation stack or dependency manifest exists.
|
||||
```
|
||||
|
||||
## Runtime Review
|
||||
|
||||
- [ ] Least-privilege runtime configuration.
|
||||
- [ ] External URLs documented.
|
||||
- [ ] Local data storage documented.
|
||||
- [ ] Sensitive data is not persisted unless explicitly required.
|
||||
|
||||
## Release Notes
|
||||
|
||||
Known residual risks:
|
||||
|
||||
```text
|
||||
The implementation stack, runtime behavior, and artifact process are not defined yet.
|
||||
```
|
||||
Reference in New Issue
Block a user