flashinfer
flashinfer copied to clipboard
[DO NOT MERGE][WIP] lint: Add clang-tidy to pre-commits
π Description
π Related Issues
π Pull Request Checklist
Add clang-tidy linter for C++/CUDA codebase as part of pre-commits
β Pre-commit Checks
- [ ] I have installed
pre-commitby runningpip install pre-commit(or used your preferred method). - [ ] I have installed the hooks with
pre-commit install. - [ ] I have run the hooks manually with
pre-commit run --all-filesand fixed any reported issues.
If you are unsure about how to set up
pre-commit, see the pre-commit documentation.
π§ͺ Tests
- [ ] Tests have been added or updated as needed.
- [ ] All tests are passing (
unittest, etc.).
Reviewer Notes
Summary of Changes
Hello @yzh119, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request integrates clang-tidy into the project's pre-commit workflow. The primary goal is to enhance code quality and consistency for C++/CUDA components by automatically checking for common errors, style violations, and potential improvements before code is committed. This setup includes a detailed configuration for clang-tidy checks and ensures its application to relevant source files.
Highlights
- Clang-Tidy Integration: Introduces
clang-tidyas a new pre-commit hook to enforce C++/CUDA coding standards and identify potential issues. - Clang-Tidy Configuration: A new
.clang-tidyconfiguration file has been added, specifying a comprehensive set of enabled and disabled checks, header filtering rules, and detailed naming conventions for various code elements (namespaces, classes, functions, variables, etc.). - Pre-commit Hook Setup: The
.pre-commit-config.yamlfile has been updated to include theclang-tidyhook, configured to run on C++, C, and CUDA files within theincludeandcsrcdirectories, while excluding3rdpartycode.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.