diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..8c4269a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +## Micromouse Software PR Template + +### Description +*Please describe the changes you've made and which module they affect (e.g., `floodfill`, `pid`, `motors`).* + +### Validation Checklist +- [ ] **Local Tests:** Did you run `./mouse test` and did all test suites pass? +- [ ] **Build Check:** Did you run `./mouse build` to ensure it fits on the Arduino Nano? +- [ ] Does the code follow project style guidelines? + +### Proposed Changes +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +### Description + +Please include a summary of the changes. diff --git a/include/config.h b/include/config.h index e69de29..6f70f09 100644 --- a/include/config.h +++ b/include/config.h @@ -0,0 +1 @@ +#pragma once diff --git a/include/encoders.h b/include/encoders.h index e69de29..6f70f09 100644 --- a/include/encoders.h +++ b/include/encoders.h @@ -0,0 +1 @@ +#pragma once diff --git a/include/floodfill.h b/include/floodfill.h index e69de29..6f70f09 100644 --- a/include/floodfill.h +++ b/include/floodfill.h @@ -0,0 +1 @@ +#pragma once diff --git a/include/ir_sens.h b/include/ir_sens.h index e69de29..6f70f09 100644 --- a/include/ir_sens.h +++ b/include/ir_sens.h @@ -0,0 +1 @@ +#pragma once diff --git a/include/mapping.h b/include/mapping.h index e69de29..6f70f09 100644 --- a/include/mapping.h +++ b/include/mapping.h @@ -0,0 +1 @@ +#pragma once diff --git a/include/motors.h b/include/motors.h index e69de29..6f70f09 100644 --- a/include/motors.h +++ b/include/motors.h @@ -0,0 +1 @@ +#pragma once diff --git a/include/pid.h b/include/pid.h index e69de29..6f70f09 100644 --- a/include/pid.h +++ b/include/pid.h @@ -0,0 +1 @@ +#pragma once diff --git a/submit b/submit new file mode 100755 index 0000000..0ae04c1 --- /dev/null +++ b/submit @@ -0,0 +1,28 @@ +#!/usr/bin/env bash + +GREEN='\033[0;32m' +BLUE='\033[0;34m' +NC='\033[0m' + +echo -e "${BLUE}Updating local Software branch...${NC}" +git checkout software +git pull origin software + +echo -n "Enter a short name for your feature (e.g., pid-fix, ir-sensors): " +read FEATURE_NAME + +BRANCH_NAME="feature/$FEATURE_NAME" + +echo -e "${BLUE}Creating branch: $BRANCH_NAME${NC}" +git checkout -b "$BRANCH_NAME" + +git add . + +echo -n "Enter your commit message: " +read COMMIT_MSG + +git commit -m "$COMMIT_MSG" +echo -e "${BLUE}Pushing to GitHub...${NC}" +git push -u origin "$BRANCH_NAME" + +echo -e "${GREEN}Go to https://github.com/IEEE-UCF/Micromouse to open your PR.${NC}"