From 9592cc663f18e3ded6374d23bd86bdb5947ad698 Mon Sep 17 00:00:00 2001 From: jubnl Date: Sun, 3 May 2026 18:48:39 +0200 Subject: [PATCH] docs: document wiki-only PR exemption from branch enforcement --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 2 +- wiki/Contributing.md | 2 +- wiki/Development-environment.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ef373d94..be0f9d72 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ ## Checklist - [ ] I have read the [Contributing Guidelines](https://github.com/mauriceboe/TREK/wiki/Contributing) - [ ] My branch is [up to date with `dev`](https://github.com/mauriceboe/TREK/wiki/Development-environment#3-keep-your-fork-up-to-date) -- [ ] This PR targets the `dev` branch, not `main` +- [ ] This PR targets the `dev` branch, not `main` *(wiki-only PRs are exempt)* - [ ] I have tested my changes locally - [ ] I have added/updated tests that prove my fix is effective or that my feature works - [ ] I have updated documentation if needed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a9ba5c3..73def1e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Thanks for your interest in contributing! Please read these guidelines before op 1. **Ask in Discord first** — Before writing any code, pitch your idea in the `#github-pr` channel on our [Discord server](https://discord.gg/NhZBDSd4qW). We'll let you know if the PR is wanted and give direction. PRs that show up without prior discussion will be closed 2. **One change per PR** — Keep it focused. Don't bundle unrelated fixes or refactors 3. **No breaking changes** — Backwards compatibility is non-negotiable -4. **Target the `dev` branch** — All PRs must be opened against `dev`, not `main` +4. **Target the `dev` branch** — All PRs must be opened against `dev`, not `main`. Exception: PRs that only modify files under `wiki/` may target any branch 5. **Match the existing style** — No reformatting, no linter config changes, no "while I'm here" cleanups 6. **Tests** — Your changes must include tests. The project maintains 80%+ coverage; PRs that drop it will be closed 7. **Branch up to date** — Your branch must be [up to date with `dev`](https://github.com/mauriceboe/TREK/wiki/Development-environment#3-keep-your-fork-up-to-date) before submitting a PR diff --git a/wiki/Contributing.md b/wiki/Contributing.md index 374db836..5d5c21d0 100644 --- a/wiki/Contributing.md +++ b/wiki/Contributing.md @@ -6,7 +6,7 @@ Thanks for your interest in contributing to TREK! Here are the guidelines for su - **Ask in Discord first** — Before writing any code, pitch your idea in the `#github-pr` channel on our [Discord server](https://discord.gg/NhZBDSd4qW). We'll let you know if the PR is wanted and give direction. PRs without prior approval will be closed - **Check existing issues** — Look for open issues or discussions before starting work -- **Target the `dev` branch** — All PRs must be opened against `dev`, not `main` +- **Target the `dev` branch** — All PRs must be opened against `dev`, not `main`. Exception: PRs that only modify files under `wiki/` may target any branch - **One thing per PR** — Keep PRs focused on a single change. Don't bundle unrelated fixes ## Pull Request Guidelines diff --git a/wiki/Development-environment.md b/wiki/Development-environment.md index af52fbdf..4b5de7d8 100644 --- a/wiki/Development-environment.md +++ b/wiki/Development-environment.md @@ -127,7 +127,7 @@ git push origin fix/my-changes:dev git push origin dev ``` -Then open a Pull Request from your fork to `mauriceboe/TREK` targeting the `dev` branch. +Then open a Pull Request from your fork to `mauriceboe/TREK` targeting the `dev` branch. If your PR only modifies files under `wiki/`, it is exempt from branch enforcement and may target any branch. ---