|
| 1 | +(# GitHub Copilot instructions for Prologue) |
| 2 | + |
| 3 | +Purpose: Help contributors and Copilot produce precise, idiomatic, and test-backed changes for the Prologue Nim web framework. |
| 4 | + |
| 5 | +- Repo summary: Prologue is a small web framework and tooling written in Nim. Prioritize clarity, minimalism, and compatibility with existing APIs. |
| 6 | +- Primary languages: Nim (core), shell (scripts for CI/tasks). |
| 7 | + |
| 8 | +Guidelines for suggestions and edits |
| 9 | +- Prefer small, well-tested changes. Avoid large rewrites unless the user explicitly requests them. |
| 10 | +- Keep public APIs stable: do not change function signatures or remove exported symbols without a clear migration plan. |
| 11 | +- Match repository conventions: follow existing naming, module layout, and style used across `src/` and `examples/`. |
| 12 | +- Include or update tests for behavioral changes. Run the project's test task locally before proposing merges. |
| 13 | + |
| 14 | +Commands the contributor should run locally |
| 15 | +- Run tests: `nimble tests` (or the repository's documented test command). |
| 16 | + |
| 17 | +Commit & PR guidance |
| 18 | +- Make focused commits with clear messages describing *why* the change was made. |
| 19 | +- Each PR should include tests or a clear justification if tests cannot be added. |
| 20 | +- Update `README.md` or `docs/` only when behavior or public usage changes. |
| 21 | + |
| 22 | +When writing code suggestions |
| 23 | +- Provide minimal reproducible examples when proposing API changes. |
| 24 | +- Explain potential breaking changes and migration steps in PR descriptions. |
| 25 | +- Prefer idiomatic Nim over clever shortcuts; prefer readability. |
| 26 | + |
| 27 | +If unsure |
| 28 | +- Ask for clarification in the PR or an issue. When requested, provide multiple alternatives and tradeoffs. |
| 29 | + |
| 30 | +Helpful links |
| 31 | +- README: [README.md](README.md) |
| 32 | +- Docs: [docs/index.md](docs/index.md) |
| 33 | + |
| 34 | +Thank you for contributing — aim for safe, test-covered improvements. |
| 35 | + |
0 commit comments