Three things are expected of a patch under <package>/patches/ and none of
them were written down for contributors.
The header has to be git am compatible, with the From/From:/Date:/Subject:
lines, which the formality check enforces. The body has to say where the
change stands with respect to upstream, so a later maintainer can tell a
backport that a version bump makes redundant from a cross-compile fix that
has to stay. And the diff has to come from the buildroot's refresh target,
which invokes quilt with -p ab --no-index --no-timestamps and
QUILT_DIFF_OPTS=-p; a git diff carries index lines and timestamps and lacks
the function name in the hunk headers, so it gets sent back even when it
applies.
Write all three down, and say what each quilt option is for rather than
just naming the command, so the reason survives the next time someone
wonders whether the timestamps matter.
llm-review-rules.md already tells the review bot about the refresh target
and the upstream reference. That file is the bot's instructions and it
points contributors here, so this is where the requirement belongs.
Signed-off-by: Josef Schlehofer <pepe@bloodkings.eu>
If you have questions about what is expected of a pull request, and there is
no specific documentation for your case, or the comments from a reviewer seem
at odds with the documentation you have found, it can be useful to refer to the
prompts given to the automated LLM reviewer. Therefore add those pointers to the
CONTRIBUTING.md document
Signed-off-by: Daniel F. Dickinson <dfdpublic@wildtechgarden.ca>
Update the Continuous Integration section to reflect the current state:
- Update the list of runtime-tested architectures (add i386_pentium-mmx
and mips_24kc, remove outdated i386_pentium4)
- Document the generic test suite (executable, version, hardcoded path,
strip, linked library, and SONAME checks)
- Add documentation for test-version.sh (version check override) and
pre-test.sh (pre-test setup) scripts alongside the existing test.sh
- Document available environment variables (PKG_NAME, PKG_VERSION,
CI_HELPERS) for test scripts
Signed-off-by: Josef Schlehofer <pepe.schlehofer@gmail.com>
Update the commit subject example in CONTRIBUTING.md
to match the documented guidelines, ensuring it uses lowercase
after the package prefix.
Signed-off-by: Wesley Gimenes <wehagy@proton.me>
The documentation stated that `PKG_VERSION` is the OpenWrt version
and therefore includes the `PKG_RELEASE`, but this statement
was incorrect and has been removed to avoid confusion.
Signed-off-by: Wesley Gimenes <wehagy@proton.me>
Corrects the commit subject being referred to as a "description"
and links the official OpenWrt patch submission standards for
commit messages. Adds additional notes about real names and
emails being required. Also fixes the capitalization of GitHub
and SourceForge.
Signed-off-by: Timothy Ace <openwrt@timothyace.com>
Also surround binaries and variable names with ticks so it's clearer
what they are.
Markdown formating via `remark-cli`.
Signed-off-by: Paul Spooren <mail@aparcar.org>
For consistency, use full name instead of $(PKG_NAME) in define and eval
lines for all packages.
I've seen reviews that asked to do this before, and I am asking the same
during reviews now. To avoid this in the future, fix this treewide so
when people use existing packages as example, we will not have to
request this change anymore.
This makes all packages consistent with both LEDE and OpenWrt base
repositories.
Signed-off-by: Stijn Tintel <stijn@linux-ipv6.be>
Josef Schlehofer
Daniel F. Dickinson
Josef Schlehofer
Wesley Gimenes
Sander Schutten
Timothy Ace
Yegor Yefremov
Paul Spooren
Florian Eckert
Alex Tomlins
Ted Hess
Stijn Tintel
Hannu Nyman
Steven Barth
Ian Leonard
Luiz Angelo Daros de Luca
Etienne CHAMPETIER