diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3e83e0f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ +## Summary +What does this PR do? + +## Type +- [ ] Feature +- [ ] Fix +- [ ] Docs +- [ ] CI + +## Testing +- [ ] Tested locally +- [ ] Tests added diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..7665965 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,38 @@ +name: ShieldCommit CI + +on: + pull_request: + push: + branches: [main] + +jobs: + test: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e . + pip install -r requirements.txt || true + + - name: Verify CLI loads + run: | + shieldcommit --help + + - name: Run tests (if available) + run: | + if [ -d tests ]; then + pip install pytest + pytest + else + echo "No tests directory, skipping tests" + fi diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b0f6ea7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing to ShieldCommit + +## Branch Rules +- main → stable only +- feature/* → new features +- fix/* → bug fixes +- docs/* → documentation + +## Workflow +1. Fork repo +2. Create branch from main +3. Open PR to main +4. CI must pass + +## Run locally +pip install -e . +pytest