From 8d590dee4bf579c185666753a5c5ce481e901cd8 Mon Sep 17 00:00:00 2001 From: neonjava Date: Wed, 28 Oct 2026 12:12:47 +0530 Subject: [PATCH] chore: establish PR review guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++++++++ AGENTS.md | 18 ++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..093053c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Implemented behavior + +## Verification + +- [ ] `cargo fmt --all -- --check` +- [ ] `cargo clippy --workspace --all-targets -- -D warnings` +- [ ] `cargo test --workspace` +- [ ] Installer dry run and shell syntax checks +- [ ] Native Wayland UI tested (describe environment and evidence) +- [ ] Display-manager login tested (describe environment and evidence) + +## Known limitations and untested behavior + +## Documentation updated + +## Next engineering task diff --git a/AGENTS.md b/AGENTS.md index a201b58..a97e975 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,3 +1,21 @@ # Neon Desktop agent guide Build a native Rust desktop for Fedora. Keep `main` buildable. Use focused crates and test real behavior. Never edit existing GNOME, KDE, or Hyprland configurations. The preview session owns separate files. Do not claim untested GUI behavior works. Run `cargo fmt --all -- --check`, `cargo clippy --workspace --all-targets -- -D warnings`, and `cargo test --workspace` before committing. Update `docs/PROJECT_STATUS.md` after each change. Review `docs/ARCHITECTURE.md` and `docs/ROADMAP.md` to resume work. Use conventional commits and MIT-compatible dependencies and assets. + +## Pull request workflow + +All new work goes on `feat/...`, `fix/...`, `docs/...`, or `refactor/...` branches. Commit and push the branch, open a pull request into `main`, and wait for CI and review. Do not push directly to `main` or merge a PR unless the user explicitly requests the merge. + +## Code Review Rules + +### Session isolation + +Flag changes that read, overwrite, or delete a user's existing GNOME, KDE, or Hyprland configuration. Neon session files must remain separate and uninstall must remove only Neon-owned files. + +### Functional claims + +Flag a feature described as working or verified when the PR contains only a mock interface, a static asset, or untested integration. Require evidence for login, launching, and system-control claims. + +### Launcher execution + +Flag application launching that interpolates desktop-entry content into a shell command. Use an established desktop-entry launcher or safe argument handling.