forked from PX4/PX4-Autopilot
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Issue and Pull Request Templates
1. Change the paragraph headings to proper Markdown headings (easier to link / structure the Markdown) 2. Move PULL_REQUEST_TEMPLATE into .github folder 3. Change description in Issue template and remove outdated DevGuide Repository information 4. Add a bug emoji to bug report isue template 5. Support automatically adding labels 'bug-report' and 'feature-request' to easily sort / filter appropriate issues in Github
- Loading branch information
1 parent
d08e5ea
commit 422be90
Showing
5 changed files
with
31 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,34 @@ | ||
--- | ||
name: Bug report | ||
name: 🐛 Bug report | ||
about: Create a report to help us improve | ||
labels: bug-report | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
## Describe the bug | ||
A clear and concise description of the bug. | ||
|
||
**To Reproduce** | ||
## To Reproduce | ||
Steps to reproduce the behavior: | ||
1. Drone switched on '...' | ||
2. Uploaded mission '....' (attach QGC mission file) | ||
3. Took off '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
## Expected behavior | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Log Files and Screenshots** | ||
## Log Files and Screenshots | ||
*Always* provide a link to the flight log file: | ||
- Download the flight log file from the vehicle ([tutorial](https://docs.px4.io/master/en/getting_started/flight_reporting.html)). | ||
- Share the link to a log showing the problem on [PX4 Flight Review](http://logs.px4.io/). | ||
- Upload the log to the [PX4 Flight Review](http://logs.px4.io/) | ||
- Share the link to the log (Copy and paste the URL of the log) | ||
|
||
Add screenshots to help explain your problem. | ||
|
||
**Drone (please complete the following information):** | ||
## Drone (please complete the following information): | ||
- Describe the type of drone. | ||
- Photo of the IMU / autopilot setup if possible. | ||
|
||
**Additional context** | ||
## Additional context | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,20 @@ | ||
--- | ||
name: 🚀 Feature Request | ||
about: Suggest an idea for this project | ||
labels: feature-request | ||
|
||
--- | ||
|
||
For general questions please use [PX4 Discuss](http://discuss.px4.io/) or Slack (you can find an invite link on this project README). | ||
|
||
**Describe problem solved by the proposed feature** | ||
## Describe problem solved by the proposed feature | ||
A clear and concise description of the problem, if any, this feature will solve. E.g. I'm always frustrated when ... | ||
|
||
**Describe your preferred solution** | ||
## Describe your preferred solution | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe possible alternatives** | ||
## Describe possible alternatives | ||
A clear and concise description of alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
## Additional context | ||
Add any other context or screenshots for the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,13 @@ | ||
--- | ||
name: ⛔ Support Question | ||
about: See [PX4 Discuss](http://discuss.px4.io/) for questions about using PX4. | ||
about: See http://discuss.px4.io/ for questions about using PX4. | ||
|
||
--- | ||
|
||
We use GitHub issues only to discuss PX4 bugs and new features. For | ||
questions about using PX4 or related components, please use [PX4 Discuss](http://discuss.px4.io/). | ||
## Attention! Please read the note below | ||
|
||
We use GitHub issues only to discuss PX4 bugs and new features. | ||
|
||
**For questions about using PX4 or related components, please use [PX4 Discuss](http://discuss.px4.io/).** | ||
|
||
Thanks! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,11 @@ | ||
--- | ||
name: ⛔ Documentation Issue | ||
about: See https://github.com/PX4/Devguide for documentation issues | ||
about: See https://github.com/PX4/px4_user_guide for documentation issues | ||
|
||
--- | ||
|
||
PX4 has dedicated repositories for developer documentation (https://github.com/PX4/Devguide) and user documentation (https://github.com/PX4/px4_user_guide). | ||
## Attention! Please read the note below | ||
|
||
**Please submit the documentation issue to the [User Guide](https://github.com/PX4/px4_user_guide) repository.** | ||
|
||
Thanks! |
12 changes: 6 additions & 6 deletions
12
PULL_REQUEST_TEMPLATE.md → .github/PULL_REQUEST_TEMPLATE.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,17 @@ | ||
Please use [PX4 Discuss](http://discuss.px4.io/) or [Slack](http://slack.px4.io/) to align on pull requests if necessary. You can then open draft pull requests to get early feedback. | ||
|
||
**Describe problem solved by this pull request** | ||
A clear and concise description of the problem this proposed change will solve. | ||
## Describe problem solved by this pull request | ||
A clear and concise description of the problem this proposed change will solve. Or, what it will improve. | ||
E.g. For this use case I ran into... | ||
|
||
**Describe your solution** | ||
## Describe your solution | ||
A clear and concise description of what you have implemented. | ||
|
||
**Describe possible alternatives** | ||
## Describe possible alternatives | ||
A clear and concise description of alternative solutions or features you've considered. | ||
|
||
**Test data / coverage** | ||
## Test data / coverage | ||
How was it tested? What cases were covered? Logs uploaded to https://review.px4.io/ and screenshots of the important plot parts. | ||
|
||
**Additional context** | ||
## Additional context | ||
Add any other related context or media. |