Skip to content

Add a pull request template #374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bharvey88 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a pull request template #374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Thanks for improving the WLED docs! -->

## What Does This PR Change?

<!-- A short description of what you changed and why. No essay needed. -->

## Checklist

- [ ] This PR covers one topic
- [ ] Content is in English and accurate for current WLED (checked against the [WLED source](https://github.com/wled/WLED) where possible)
- [ ] The information isn't already on another page (cross-link instead of duplicating)
- [ ] Tone is informal and friendly, sentences are short, headings use Title Case
- [ ] Internal links are root-relative without `.md` (e.g. `/features/segments`)
- [ ] Images live in `docs/assets/images/content/`, not on external hosts
- [ ] Code blocks have a language hint; callouts use `!!! info` / `tip` / `warning` / `danger`
- [ ] A new page starts with a front matter `title` and is registered under `nav:` in `mkdocs.yml`
- [ ] Previewed locally with `mkdocs serve` or Docker
2 changes: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ Indentation in `mkdocs.yml` is significant.

## PR Review Checklist

Contributors see a condensed version of this list in the PR template (`.github/PULL_REQUEST_TEMPLATE.md`). When updating either list, keep the two in agreement.

When reviewing a pull request, verify the following:

### Content
Expand Down
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ For larger edits, work from a branch in your own fork rather than your `main` br

Please keep each PR focused on one topic, and add a short description of what you changed and why. No need to write an essay.

When you open the PR, GitHub pre-fills the description with our template, a what/why prompt and a short checklist. Fill it in rather than deleting it.

## Writing Style

We're harmonizing the docs for readability, so please follow the conventions in [AGENTS.md](AGENTS.md) (our contributor and AI-agent instructions). The short version:
Expand Down