From 912578fb1fc229c175c3dca095ce3784a510156f Mon Sep 17 00:00:00 2001 From: clayjay3 Date: Fri, 22 Mar 2024 02:49:12 +0000 Subject: [PATCH 1/3] Fix TODO tree extension. --- .devcontainer/devcontainer.json | 51 ++++++++++++++++++++------- src/states/ApproachingObjectState.cpp | 8 +++++ 2 files changed, 47 insertions(+), 12 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index be6a9a17..c4d41376 100755 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -166,21 +166,48 @@ "doxdocgen.generic.useGitUserName": true, // Todo Tree Extention Settings "todo-tree.general.tags": [ - "FIXME:", - "TODO:", - "LEAD:", - "ISSUE NOTE:" + "TODO", + "BUG", + "HACK", + "FIXME", + "LEAD", + "ISSUE NOTE", + "TEST", + "[ ]", + "[x]" ], + "todo-tree.highlights.defaultHighlight": { + "icon": "alert", + "type": "text", + "foreground": "#00ff00", + "background": "#ffffff", + "opacity": 50, + "iconColour": "#00ff00" + }, "todo-tree.highlights.customHighlight": { "TODO": { - "icon": "check", + "icon": "bookmark", "type": "line", "iconColour": "#d000ff", "foreground": "#ffffff", "background": "#d000ff" }, + "BUG": { + "icon": "bug", + "type": "line", + "iconColour": "#ff8c00", + "foreground": "#ffffff", + "background": "#ff8c00" + }, + "HACK": { + "icon": "circle-slash", + "type": "line", + "iconColour": "#ff1e00", + "foreground": "#ffffff", + "background": "#ff1e00" + }, "FIXME": { - "icon": "beaker", + "icon": "alert-fill", "type": "line", "iconColour": "#ff0000", "foreground": "#ffffff", @@ -189,22 +216,22 @@ "LEAD": { "icon": "person", "type": "line", - "iconColour": "#ffffff", - "foreground": "#000000", - "background": "#ffffff" + "iconColour": "#0700d8", + "foreground": "#ffffff", + "background": "#0700d8" }, "ISSUE NOTE": { "icon": "book", "type": "line", "iconColour": "#808080", - "foreground": "#000000", + "foreground": "#ffffff", "background": "#808080" }, "TEST": { - "icon": "book", + "icon": "beaker", "type": "line", "iconColour": "#c5cb04", - "foreground": "#000000", + "foreground": "#ffffff", "background": "#ccd514" } }, diff --git a/src/states/ApproachingObjectState.cpp b/src/states/ApproachingObjectState.cpp index c1d2ba8f..1fa284f9 100644 --- a/src/states/ApproachingObjectState.cpp +++ b/src/states/ApproachingObjectState.cpp @@ -78,6 +78,14 @@ namespace statemachine void ApproachingObjectState::Run() { // TODO: Implement the behavior specific to the Approaching Object state + // BUG: This breaks occasionally. + // HACK: This is bad, never do this. + // FIXME: AAAHAHAHHAAH + // LEAD: AHAHAHAHA + // ISSUE NOTE: WHAT THE HELL + // TEST: LKFJLSKDFJLKSDjf + // [ ] this is a list item. + // [x] this is a checked list item. LOG_DEBUG(logging::g_qSharedLogger, "ApproachingObjectState: Running state-specific behavior."); } From 064e17ae656d30fc464e365995f84b67cdb83167 Mon Sep 17 00:00:00 2001 From: clayjay3 Date: Fri, 22 Mar 2024 03:10:16 +0000 Subject: [PATCH 2/3] Make PR changes. --- CONTRIBUTING.md | 15 +++++++++++++++ src/states/ApproachingObjectState.cpp | 10 +--------- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c891b24..f0889f16 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,6 +53,21 @@ Commit names should be no more than 50 characters. They should have `#` to mark that the pull request will fix an issue. +## Marking Issues in Code + +### Utilizing TODO-Trees + +A list of action items can be built in the TODO extension tab using these keywords to highlight and mark sections of code for later review: + // TODO: Implement the behavior specific to the Approaching Object state + // BUG: This breaks occasionally. + // HACK: This is bad, never do this. + // FIXME: Broken + // LEAD: Check this out... + // ISSUE NOTE: This is messed up. + // TEST: Make sure this works, write unit tests. + // [ ] This is a list item. + // [x] This is a checked list item. + ## Styleguides ### Variable Names diff --git a/src/states/ApproachingObjectState.cpp b/src/states/ApproachingObjectState.cpp index 1fa284f9..4f97cf60 100644 --- a/src/states/ApproachingObjectState.cpp +++ b/src/states/ApproachingObjectState.cpp @@ -77,15 +77,7 @@ namespace statemachine ******************************************************************************/ void ApproachingObjectState::Run() { - // TODO: Implement the behavior specific to the Approaching Object state - // BUG: This breaks occasionally. - // HACK: This is bad, never do this. - // FIXME: AAAHAHAHHAAH - // LEAD: AHAHAHAHA - // ISSUE NOTE: WHAT THE HELL - // TEST: LKFJLSKDFJLKSDjf - // [ ] this is a list item. - // [x] this is a checked list item. + // TODO: Implement the behavior specific to the Approaching Object state. LOG_DEBUG(logging::g_qSharedLogger, "ApproachingObjectState: Running state-specific behavior."); } From eff71f6a9fd55366101fe0ddc19ea1c8bf3deb56 Mon Sep 17 00:00:00 2001 From: clayjay3 Date: Fri, 22 Mar 2024 03:11:50 +0000 Subject: [PATCH 3/3] Fix formatting. --- CONTRIBUTING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f0889f16..f0f01295 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,15 +58,15 @@ Pull Request names should be no more than 50 characters. The description should ### Utilizing TODO-Trees A list of action items can be built in the TODO extension tab using these keywords to highlight and mark sections of code for later review: - // TODO: Implement the behavior specific to the Approaching Object state - // BUG: This breaks occasionally. - // HACK: This is bad, never do this. - // FIXME: Broken - // LEAD: Check this out... - // ISSUE NOTE: This is messed up. - // TEST: Make sure this works, write unit tests. - // [ ] This is a list item. - // [x] This is a checked list item. +- // TODO: Implement the behavior specific to the Approaching Object state +- // BUG: This breaks occasionally. +- // HACK: This is bad, never do this. +- // FIXME: Broken +- // LEAD: Check this out... +- // ISSUE NOTE: This is messed up. +- // TEST: Make sure this works, write unit tests. +- // [ ] This is a list item. +- // [x] This is a checked list item. ## Styleguides