Skip to content
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.

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

Update developer documentation on how to run linters #192

Open
bouweandela opened this issue Jul 4, 2023 · 0 comments
Open

Update developer documentation on how to run linters #192

bouweandela opened this issue Jul 4, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@bouweandela
Copy link
Member

The developer documentation mentions running the linters with the make tool, but this was removed because it duplicated the features implemented by pre-commit. The documentation here

cudawrappers/README.dev.md

Lines 141 to 152 in d7f133c

To run the formatters and linters, you first need to build the project. After this run:
```sh
cd build
make format
make lint
```
You can also run the individual tools by calling
```sh
make <tool_name>

needs to be updated so it mentions pre-commit install and pre-commit run instead.

It would be good to add that the version of the tools (clang etc) in .pre-commit-config.yml and environment.yml needs to be kept in sync.

@bouweandela bouweandela added the documentation Improvements or additions to documentation label Jul 4, 2023
@matmanc matmanc self-assigned this Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants