This commit is contained in:
commit
aa30e3734e
3 files changed
+21
-6
No files matched your search
@@ -18,6 +18,15 @@ Thanks for considering contributing to this project!
|
||||
|
||||
### 3. Submitting Code Changes (Pull Requests)
|
||||
|
||||
The project receives far more code than it is able to process.
|
||||
To increase the likelihood of your PR being accepted, please consider
|
||||
the following:
|
||||
|
||||
- **Keep it small.** Changes of about 10 lines or fewer were merged 64% of the time; changes over 1000 lines, 10%.
|
||||
- **Keep the description short.** A few sentences on what changed and why is enough. Longer descriptions were merged less often.
|
||||
- **Build a track record with small fixes first.** First-time contributors were merged 31% of the time, rising to 74% after 10 merged PRs.
|
||||
- **Open the PR when it is ready for review, not as a draft.**
|
||||
|
||||
#### Small fixes (typos, comments, examples, small bug fixes)
|
||||
→ Just open a pull request — no prior issue needed
|
||||
|
||||
@@ -52,6 +61,15 @@ Please follow the existing C++ style (per the .clang-format)
|
||||
|
||||
(But consistency with existing code is more important than strict rules)
|
||||
|
||||
## LLM Agent Specific Advice
|
||||
|
||||
- **Have a human read and understand every line before opening the PR.** Check every claim in the description against the code.
|
||||
- **Search open PRs first** so you don't duplicate one that's already waiting.
|
||||
- **Pick a subsystem maintainers are actively merging in.** If several PRs for the same board or feature have sat for weeks with no response, a new one will likely sit too.
|
||||
- **Prefer low-risk changes.** Build fixes and documentation fixes merge most often (about 61% and 64%). Changes to protocol or behavior, and crash or overflow fixes, get much more scrutiny.
|
||||
- **Make a minimal diff in the existing style.** Don't reformat, rename, or "tidy" code next to your change.
|
||||
- **Don't use a templated description.** Lots of headings and boilerplate on a small change reads as generated. Just say what changed, why, and what hardware you tested on.
|
||||
|
||||
## Thank You!
|
||||
|
||||
> [!NOTE]
|
||||
|
||||
@@ -341,7 +341,7 @@ uint8_t MyMesh::getAutoAddMaxHops() const {
|
||||
|
||||
void MyMesh::onContactOverwrite(const uint8_t* pub_key) {
|
||||
_store->deleteBlobByKey(pub_key, PUB_KEY_SIZE); // delete from storage
|
||||
if (_serial->isConnected()) {
|
||||
if (_serial && _serial->isConnected()) {
|
||||
out_frame[0] = PUSH_CODE_CONTACT_DELETED;
|
||||
memcpy(&out_frame[1], pub_key, PUB_KEY_SIZE);
|
||||
_serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE);
|
||||
@@ -349,7 +349,7 @@ void MyMesh::onContactOverwrite(const uint8_t* pub_key) {
|
||||
}
|
||||
|
||||
void MyMesh::onContactsFull() {
|
||||
if (_serial->isConnected()) {
|
||||
if (_serial && _serial->isConnected()) {
|
||||
out_frame[0] = PUSH_CODE_CONTACTS_FULL;
|
||||
_serial->writeFrame(out_frame, 1);
|
||||
}
|
||||
|
||||
@@ -34,6 +34,7 @@ build_src_filter = ${nrf52_base.build_src_filter}
|
||||
+<../variants/meshtracker_x1>
|
||||
lib_deps = ${nrf52_base.lib_deps}
|
||||
https://github.com/adafruit/Adafruit_SPA06_003/archive/refs/tags/1.0.2.zip
|
||||
stevemarple/MicroNMEA @ ^2.0.6
|
||||
debug_tool = jlink
|
||||
upload_protocol = nrfutil
|
||||
|
||||
@@ -51,7 +52,6 @@ build_flags = ${MeshTracker_X1.build_flags}
|
||||
build_src_filter = ${MeshTracker_X1.build_src_filter}
|
||||
+<../examples/simple_repeater>
|
||||
lib_deps = ${MeshTracker_X1.lib_deps}
|
||||
stevemarple/MicroNMEA @ ^2.0.6
|
||||
|
||||
[env:MeshTracker_X1_room_server]
|
||||
extends = MeshTracker_X1
|
||||
@@ -67,7 +67,6 @@ build_flags = ${MeshTracker_X1.build_flags}
|
||||
build_src_filter = ${MeshTracker_X1.build_src_filter}
|
||||
+<../examples/simple_room_server>
|
||||
lib_deps = ${MeshTracker_X1.lib_deps}
|
||||
stevemarple/MicroNMEA @ ^2.0.6
|
||||
|
||||
[env:MeshTracker_X1_companion_radio_usb]
|
||||
extends = MeshTracker_X1
|
||||
@@ -94,7 +93,6 @@ build_src_filter = ${MeshTracker_X1.build_src_filter}
|
||||
+<../examples/companion_radio/ui-orig/*.cpp>
|
||||
lib_deps = ${MeshTracker_X1.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
stevemarple/MicroNMEA @ ^2.0.6
|
||||
end2endzone/NonBlockingRTTTL@^1.3.0
|
||||
adafruit/Adafruit DRV2605 Library @ ^1.2.4
|
||||
|
||||
@@ -127,7 +125,6 @@ build_src_filter = ${MeshTracker_X1.build_src_filter}
|
||||
+<../examples/companion_radio/ui-orig/*.cpp>
|
||||
lib_deps = ${MeshTracker_X1.lib_deps}
|
||||
densaugeo/base64 @ ~1.4.0
|
||||
stevemarple/MicroNMEA @ ^2.0.6
|
||||
end2endzone/NonBlockingRTTTL@^1.3.0
|
||||
adafruit/Adafruit DRV2605 Library @ ^1.2.4
|
||||
|
||||
|
||||
Reference in new issue
Block a user