Skip to content

Commit c43ded6

Browse files
committed
Merge remote-tracking branch 'origin/master' into pr-rtk-fix-improvement
2 parents 20e34f5 + 4757158 commit c43ded6

File tree

1,571 files changed

+55694
-11763
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,571 files changed

+55694
-11763
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 27 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -3,92 +3,45 @@ description: Create a report to help us improve
33
title: "[Bug] "
44
labels: ["bug-report"]
55
body:
6-
- type: textarea
6+
- type: markdown
77
attributes:
8-
label: Describe the bug
9-
description: A clear and concise description of the bug.
10-
validations:
11-
required: true
8+
value: |
9+
**Tips for a great bug report:**
10+
- Describe what went wrong and what you expected
11+
- Include a flight log link from [logs.px4.io](http://logs.px4.io/) if possible
12+
- Mention your PX4 version, flight controller, and vehicle type if relevant
1213
1314
- type: textarea
1415
attributes:
15-
label: To Reproduce
16-
description: |
17-
Steps to reproduce the behavior.
18-
1. Drone switched on '...'
19-
2. Uploaded mission '....' (attach QGC mission file)
20-
3. Took off '....'
21-
4. See error
22-
validations:
23-
required: false
16+
label: Describe the bug
17+
description: A clear description of the bug and what you expected to happen.
18+
placeholder: |
19+
What happened and what did you expect instead?
2420
25-
- type: textarea
26-
attributes:
27-
label: Expected behavior
28-
description: A clear and concise description of what you expected to happen.
21+
Steps to reproduce (if applicable):
22+
1.
23+
2.
24+
3.
2925
validations:
30-
required: false
31-
32-
- type: textarea
33-
attributes:
34-
label: Screenshot / Media
35-
description: Add screenshot / media if you have them
26+
required: true
3627

3728
- type: textarea
3829
attributes:
39-
label: Flight Log
30+
label: Flight Log / Additional Information
4031
description: |
41-
*Always* provide a link to the flight log file:
42-
- Download the flight log file from the vehicle ([tutorial](https://docs.px4.io/main/en/getting_started/flight_reporting.html)).
43-
- Upload the log to the [PX4 Flight Review](http://logs.px4.io/)
44-
- Share the link to the log (Copy and paste the URL of the log)
32+
**Flight log** (highly recommended for flight-related issues):
33+
- Upload to [PX4 Flight Review](http://logs.px4.io/) and paste the link
34+
35+
**Additional details** (if relevant):
36+
- PX4 version (output of `ver all` in MAVLink Shell)
37+
- Flight controller model
38+
- Vehicle type (multicopter, fixed-wing, VTOL, etc.)
39+
- Screenshots or media
4540
placeholder: |
46-
# PASTE HERE THE LINK TO THE LOG
47-
validations:
48-
required: false
41+
Flight log link:
4942
50-
- type: markdown
51-
attributes:
52-
value: |
53-
## Setup
43+
Version:
5444
55-
- type: textarea
56-
attributes:
57-
label: Software Version
58-
description: |
59-
Which version of PX4 are you using?
60-
placeholder: |
61-
# If you don't know the version, paste the output of `ver all` in the MAVLink Shell of QGC
45+
Hardware:
6246
validations:
6347
required: false
64-
65-
- type: input
66-
attributes:
67-
label: Flight controller
68-
description: Specify your flight controller model (what type is it, where was it bought from, ...).
69-
validations:
70-
required: false
71-
72-
- type: dropdown
73-
attributes:
74-
label: Vehicle type
75-
options:
76-
- Multicopter
77-
- Helicopter
78-
- Fixed Wing
79-
- Hybrid VTOL
80-
- Airship/Balloon
81-
- Rover
82-
- Boat
83-
- Submarine
84-
- Other
85-
86-
- type: textarea
87-
attributes:
88-
label: How are the different components wired up (including port information)
89-
description: Details about how all is wired.
90-
91-
- type: textarea
92-
attributes:
93-
label: Additional context
94-
description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
blank_issues_enabled: false
1+
blank_issues_enabled: true
22
contact_links:
33
- name: Support Question
44
url: https://docs.px4.io/main/en/contribute/support.html#forums-and-chat

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,9 @@
11
<!--
22
3-
Thank you for your contribution!
4-
5-
Get early feedback through
6-
- Dronecode Discord: https://discord.gg/dronecode
7-
- PX4 Discuss: http://discuss.px4.io/
8-
- opening a draft pr and sharing the link
9-
10-
-->
11-
123
### Solved Problem
13-
When ... I found that ...
14-
154
Fixes #{Github issue ID}
165
176
### Solution
18-
- Add ... for ...
19-
- Refactor ...
207
218
### Changelog Entry
229
For release notes:
@@ -27,11 +14,10 @@ Documentation: Need to clarify page ... / done, read docs.px4.io/...
2714
```
2815
2916
### Alternatives
30-
We could also ...
3117
3218
### Test coverage
33-
- Unit/integration test: ...
34-
- Simulation/hardware testing logs: https://review.px4.io/
3519
3620
### Context
3721
Related links, screenshot before/after, video
22+
23+
-->
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
applyTo: "docs/en/**"
3+
---
4+
5+
# Review Guidelines docs/en Tree
6+
7+
## File System & Structure
8+
9+
- **Naming:** Use `lowercase_with_underscores` for all filenames. No spaces.
10+
- **Hierarchy:** Markdown files must reside exactly in a first-level category folder.
11+
- Valid: `docs/en/category/file.md`
12+
- Invalid: `docs/en/category/subcategory/file.md`
13+
- **Text Files:** Any `.txt` or `.text` files must start with an underscore (e.g., `_notes.txt`).
14+
- **Assets:** All images/non-docs must be in `/docs/assets/`. Deep nesting is permitted here.
15+
- **Formats:** Prefer **SVG** for diagrams and **PNG** for screenshots. Flag JPG files.
16+
17+
## Markdown & Style
18+
19+
- **Headings:** Use Title Case ("First Letter Capitalisation").
20+
- The Page Title must be the only H1 (`#`). All others must be `##` or lower.
21+
- Do not apply bold or italic styling inside a heading.
22+
- **Formatting:**
23+
- **Bold:** Only for UI elements (buttons, menu items).
24+
- **Italics (Emphasis):** For tool names (e.g., *QGroundControl*).
25+
- **Inline Code:** Use backticks for file paths, parameters, and CLI commands (e.g., `prettier`).
26+
- **Structure:** End every line at the end of a sentence (Semantic Line Breaks).
27+
28+
## Linking & Navigation
29+
30+
- **Standard Links:** Use standard inline syntax: `[link text](../category/filename.md)`.
31+
Note relative link.
32+
- **Table Links:** To keep tables readable, use reference-style links.
33+
- Definition: `[Link Name]: https://example.com` (placed below the table).
34+
- Usage: `[Link Name]` within the table cell.
35+
- **Images:** All image links must include a descriptive, accessible alt-text in the brackets: `![Detailed description of the image content](../../assets/path/to/image.png)`.
36+
Note that all images should be relative references to images stored in the assets folder, which should be two folders below the any markdown file (as they are stored in a "category" subfolder)
37+
38+
- **Standard Links:** Use standard inline syntax: `[link text](../category/filename.md)`. Note the use of relative links.
39+
- **Table Links:** To keep tables easier to edit, prefer reference-style links.
40+
- Definition: `[Link Name]: https://example.com` (placed below the table).
41+
- Usage: `[Link Name]` within the table cell.
42+
- **Images:** All image links must include a descriptive, accessible alt-text: `![Detailed description of the image content](../../assets/path/to/image.png)`.
43+
- **Note:** All images must be relative references to the `/docs/assets/` folder. Since documents are nested in a category folder, this is usually two levels up (`../../assets/`).
44+
45+
## Quality Control
46+
47+
- **Prettier Check:** Ensure Prettier rules have been applied. If there is evidence of inconsistent indentation or spacing, request the author run `npx prettier --write .` before merging.
48+
- **Language:** Enforce **UK English** spelling and grammar.

.github/runs-on.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
runners:
2+
x86-small-runner:
3+
cpu: [1, 2]
4+
ram: [1, 4]
5+
disk: default
6+
spot: price-capacity-optimized
7+
image: ubuntu24-full-x64
8+
extras: s3-cache
9+
x86-firmware-builder:
10+
cpu: [4, 8]
11+
ram: [8, 16]
12+
disk: default
13+
family: ["c7i", "m7i", "r7i"]
14+
spot: price-capacity-optimized
15+
image: ubuntu24-full-x64
16+
extras: s3-cache
17+
arm64-firmware-builder:
18+
cpu: [4, 8]
19+
ram: [8, 16]
20+
disk: default
21+
family: ["c7g", "m7g", "r7g"]
22+
spot: price-capacity-optimized
23+
image: ubuntu24-full-arm64
24+
extras: s3-cache

0 commit comments

Comments
 (0)