Skip to content

docs: contributing guide references removed clang-format workflow #5232

Description

@Sev7een

docs: contributing guide references removed clang-format workflow

What I noticed

While reading through the contributing guide, I noticed the Clang Format section references .github/workflows/cpp-clang-format-lint.yml, but that workflow file is not present in the current repo. The current lint entrypoint appears to be .github/workflows/_common-lint.yml, which calls LizardByte's shared common lint workflow.

The local formatting command in the same section also looks a little stale: it misses .c/.hpp, leaves globs unquoted, and does not use null-safe arguments.

Suggested fix

Update docs/contributing.md so the Clang Format section:

  • points to .github/workflows/_common-lint.yml
  • matches the C/C++ extensions checked by the shared lint workflow
  • uses a safer find ... -print0 | xargs -0 ... command

I can open a small docs PR for this if that sounds right.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions