meshtastic-firmware/.github/pull_request_template.md

16 wiersze
1.3 KiB
Markdown

2024-09-05 21:25:34 +00:00
### ❌ (Please delete all these tips and replace them with your text) ❌
2020-06-25 16:33:29 +00:00
2024-09-05 21:25:34 +00:00
## Thank you for sending in a pull request, here's some tips to get started!
2020-06-25 16:33:29 +00:00
- Before starting on some new big chunk of code, it it is optional but highly recommended to open an issue first
2024-09-05 21:25:34 +00:00
to say "Hey, I think this idea X should be implemented and I'm starting work on it. My general plan is Y, any feedback
2020-06-25 16:33:29 +00:00
is appreciated." This will allow other devs to potentially save you time by not accidentially duplicating work etc...
- Please do not check in files that don't have real changes
- Please do not reformat lines that you didn't have to change the code on
- We recommend using the [Visual Studio Code](https://platformio.org/install/ide?install=vscode) editor along with the ['Trunk Check' extension](https://marketplace.visualstudio.com/items?itemName=trunk.io) (In beta for windows, WSL2 for the linux version),
because it automatically follows our indentation rules and its auto reformatting will not cause spurious changes to lines.
2020-06-25 16:33:29 +00:00
- If your PR fixes a bug, mention "fixes #bugnum" somewhere in your pull request description.
- If your other co-developers have comments on your PR please tweak as needed.
- Please also enable "Allow edits by maintainers".
2024-09-05 21:25:34 +00:00
- If your PR gets accepted you can request a "Contributor" role in the Meshtastic Discord