Skip to content

[DOC]: Update Contributing Guide/CI Overview to include information about pre-commit #1623

@jrhemstad

Description

@jrhemstad

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

New

Describe the incorrect/future/missing documentation

As a contributor to CCCL, I'd like to know whatever it is I need to know to ensure my contributions are formatted correctly and will pass the CI format check.

### Tasks
- [ ] Add "Pre-Commit Linters" section to contributing guide with top-level overview of precommit and subsection for clang-format
- [ ] Update CI Overview to add section about pre-commit.ci 

The desired outcome is that if the pre-commit.ci job fails, people should have somewhere to go to tell them how to fix it. This should include:

  • Information about how to run formatting locally (whether with VSCode or pre-commit directly)
  • Information about how to use the pre-commit.ci autofix comment on a PR to automatically apply pre-commit linters

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions