52 lines
1.3 KiB
Markdown
52 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
Steam Backlog Helper is personal-use first but should be shaped for an eventual open-source release.
|
|
|
|
## Before Starting
|
|
|
|
Read:
|
|
|
|
- `README.md`
|
|
- `AGENTS.md`
|
|
- `docs/implementation-plan.md`
|
|
- `docs/architecture-decisions.md`
|
|
- `SECURITY.md`
|
|
|
|
## Scope Discipline
|
|
|
|
The MVP is a recommendation picker. Avoid adding full backlog-management features until the picker is working.
|
|
|
|
Out of scope for MVP:
|
|
|
|
- Import/export.
|
|
- Recommendation history.
|
|
- Accepted/rejected tracking.
|
|
- Mood tagging.
|
|
- Installed-game detection.
|
|
- Manual metadata editing.
|
|
- Private-profile fallback import.
|
|
|
|
## Code Standards
|
|
|
|
- Use strict TypeScript.
|
|
- Keep recommendation logic independent of UI where practical.
|
|
- Keep Rust command payloads typed and explicit.
|
|
- Add tests for featureful logic.
|
|
- Preserve keyboard accessibility for setup and picker flows.
|
|
- Do not commit real API keys or personal library data.
|
|
|
|
## Commit And Branch Guidance
|
|
|
|
The repository owner will initialize Git. Once Git is initialized, prefer small branches focused on one feature or fix.
|
|
|
|
Suggested commit style:
|
|
|
|
- `docs: update implementation plan`
|
|
- `feat: import steam library`
|
|
- `fix: redact api keys in logs`
|
|
- `test: cover recommendation scoring`
|
|
|
|
## Release Guidance
|
|
|
|
Gitea is the primary release target. CI should be designed for Gitea runners first, with a possible future GitHub mirror.
|