Skip to content

clean up linting, ignores, and precommit workflow #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zeerekahmad merged 1 commit into from
Aug 18, 2026
Merged

clean up linting, ignores, and precommit workflow #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .cpplint.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ filter=-build/c++17
# Per our style guide, we want to allow the use of non-const reference passing for output parameters
filter=-runtime/references

# Catch2 idiom is `CHECK(a == b)` with expression decomposition; CHECK_EQ is a gtest macro and not applicable here
filter=-readability/check

@skyegalaxy skyegalaxy Aug 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this has annoyed me enough in our other catch2 repos that we ought to consider checking it into polymath_code_standard (cc @emersonknapp)

alternatively, I get the linter to stop complaining by replacing CHECK with REQUIRE (claude always likes to do CHECK for some reason)

@zeerekahmad zeerekahmad Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I generally just switch to REQUIRE but this felt fine


# Disable all formatting checks, this is handled by clang-format
filter=-readability/braces
filter=-whitespace/braces
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pre-commit.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- uses: actions/checkout@v5
- uses: actions/setup-python@v6
with:
python-version: "3.10"
- run: sudo apt-get update && sudo apt-get install libxml2-utils
Expand Down
13 changes: 12 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Colcon
# Colcon (when built from the workspace root, build/ lives there)
/build/
/install/
/log/

# Python / uv
.venv/
__pycache__/
*.py[cod]
*.egg-info/
.pytest_cache/
.ruff_cache/

# Build artifacts from CMake direct invocation
*.so
Loading