mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-11-22 14:19:57 +08:00
* docs(contributing): discourage force-pushing during review A force-push after review has begun erases the commits a reviewer has read, so they cannot see what changed since. The guidance told contributors to squash and reword instead, which contradicts the commit and pr agent skills. PRs are typically squash-merged, so branch history does not need cleaning up before merge. Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com> * ci(workflows): remove commit message check PRs are squash-merged under the PR title, which is still checked. Flagging the individual commits pushed contributors to rewrite history mid-review. Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com> --------- Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com>
2.1 KiB
2.1 KiB
applyTo
| applyTo |
|---|
| src/**,boards/**,platforms/**,msg/**,cmake/**,Makefile,CMakeLists.txt,Tools/**,.github/** |
PX4 Code Review Guidelines
Conventions
- PR titles must follow conventional commits:
type(scope): description(see CONTRIBUTING.md) - Types:
feat,fix,docs,style,refactor,perf,test,build,ci,chore,revert - Scope should match the primary area of changed files
- Append
!before the colon for breaking changes - PRs are typically squash-merged, so the PR title becomes the commit message on
main; merge commits are disabled - Review feedback is addressed with new commits; do not ask for a squash or force-push during review, except to rebase onto
main
Core Checks (always apply)
- Correctness: logic errors, off-by-ones, unhandled edge cases
- Type safety: int16 overflow, float/double promotion, unsigned subtraction, use
uint64_tfor absolute time - Initialization: uninitialized variables, missing default construction
- Buffer safety: unchecked array access, stack allocation of large buffers, snprintf bounds
- Magic numbers: every numeric literal needs a named constant or justification
- Framework reuse: use PX4_ERR/WARN/INFO, existing libraries (AlphaFilter, SlewRate, RateControl), MAVLink constants from the library
- Naming: accurate, no unjustified abbreviations, current terminology (GPS -> GNSS for new code)
- Unnecessary complexity: can code be removed instead of added? Is there a simpler pattern?
- Test coverage: new features should include unit or integration tests; bug fixes should include regression tests where practical
- Formatting:
make format/make check_format(astyle) for C/C++ files;clang-tidyclean - Coding style: C/C++ must follow the PX4 coding style (https://docs.px4.io/main/en/contribute/code.html)
- Necessity: challenge every addition. Is this actually needed or just copied?
- Architecture fit: does the code live in the module that naturally owns the data? No unnecessary cross-module dependencies
- Ecosystem impact: consider QGC users, log analysis tools, and third-party integrations