devtu-github

DevTU GitHub Workflow

Safely push ToolUniverse code to GitHub by enforcing pre-push cleanup, pre-commit hooks, and test validation.

Instructions

When the user wants to push code, fix CI, or prepare a commit, follow this workflow:

Phase 1: Pre-Push Cleanup

1. Move temp files out of root - session docs and ad-hoc test scripts must NOT be pushed:

# Move session markdown files to temp_docs_and_tests/
for f in $(ls *.md 2>/dev/null | grep -v README.md | grep -v CHANGELOG.md | grep -v LICENSE.md); do
  mv "$f" temp_docs_and_tests/
done

# Move root-level test scripts to temp_docs_and_tests/
for f in $(ls test_*.py 2>/dev/null); do
  mv "$f" temp_docs_and_tests/
done

1. Verify nothing unwanted is staged:

git status --short

Red flags - these should NEVER be staged:

• *_SUMMARY.md, *_REPORT.md, SESSION_*.md in root
• test_*.py in root (these are ad-hoc scripts, not real tests)
• .env or credential files
• temp_docs_and_tests/ contents

Phase 2: Activate Pre-Commit Hooks

1. Ensure pre-commit is installed and active:

pre-commit install

This enables automatic checks on every git commit:

• ruff check --fix - Python linting with auto-fix
• ruff format - Code formatting
• YAML/TOML validation
• Trailing whitespace removal
• End of file fixes

1. Verify hooks are active:

ls -la .git/hooks/pre-commit

Phase 3: Run Tests

1. Run the full test suite locally:

python -m pytest tests/ -x --tb=short -q

1. If tests fail, diagnose using the error patterns below and fix before proceeding.

Phase 4: Commit and Push

1. Stage only specific files (never use git add . or git add -A):

git add src/tooluniverse/specific_file.py tests/specific_test.py

1. Commit (pre-commit hooks run automatically):

git commit -m "Clear, descriptive message"

1. Rebase onto latest main BEFORE pushing (CRITICAL — prevents PR conflicts):