docs: remove contribution docs
This commit is contained in:
@@ -1,54 +0,0 @@
|
|||||||
# Contributing
|
|
||||||
|
|
||||||
Thanks for your interest in improving MAL.
|
|
||||||
|
|
||||||
## Before you start
|
|
||||||
|
|
||||||
- Open an issue first for large changes so scope is clear
|
|
||||||
- Keep pull requests focused and small when possible
|
|
||||||
- Prioritize user-facing clarity: cleaner flows, less friction, better defaults
|
|
||||||
|
|
||||||
## Local setup
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# install templ CLI
|
|
||||||
go install github.com/a-h/templ/cmd/templ@latest
|
|
||||||
|
|
||||||
# install frontend tooling
|
|
||||||
bun install
|
|
||||||
|
|
||||||
# generate templates
|
|
||||||
templ generate
|
|
||||||
|
|
||||||
# build frontend assets (tailwind + typescript)
|
|
||||||
bun run build:assets
|
|
||||||
|
|
||||||
# run tests
|
|
||||||
go test ./...
|
|
||||||
|
|
||||||
# run app
|
|
||||||
go run ./cmd/server
|
|
||||||
```
|
|
||||||
|
|
||||||
TypeScript source files live in `static/*.ts` and are bundled to runtime assets in `dist/`.
|
|
||||||
Generated `dist/` files are ignored by git.
|
|
||||||
|
|
||||||
## Development guidelines
|
|
||||||
|
|
||||||
- Follow existing folder boundaries (`internal/features/*`, `internal/jikan`, `internal/templates`)
|
|
||||||
- Prefer simple, explicit solutions over broad abstractions
|
|
||||||
- Do not add dependencies unless there is a clear benefit
|
|
||||||
- Keep generated files in sync when changing `.templ` or SQL query definitions
|
|
||||||
|
|
||||||
## Pull request checklist
|
|
||||||
|
|
||||||
- Explain the user problem this change solves
|
|
||||||
- Describe tradeoffs or constraints
|
|
||||||
- Include before/after behavior notes
|
|
||||||
- Ensure `go test ./...` passes locally
|
|
||||||
|
|
||||||
## Security
|
|
||||||
|
|
||||||
- Never commit secrets, private tokens, or real credentials
|
|
||||||
- Keep `.env` values local
|
|
||||||
- Report security issues privately before public disclosure
|
|
||||||
@@ -138,10 +138,6 @@ go test ./...
|
|||||||
|
|
||||||
There is currently no CI workflow in this repository, so validation is local.
|
There is currently no CI workflow in this repository, so validation is local.
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
This is primarily a personal project, so development priorities are driven by my own use and preferences. That said, if you spot a bug or have a focused improvement, feel free to open an issue or pull request. Please read `CONTRIBUTING.md` first so expectations around scope, validation, and security handling are clear.
|
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
||||||
Keep secrets out of version control, do not publish real credentials in documentation or screenshots, and report security issues privately before public disclosure.
|
Keep secrets out of version control, do not publish real credentials in documentation or screenshots, and report security issues privately before public disclosure.
|
||||||
|
|||||||
Reference in New Issue
Block a user