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

docs: add a note on setting up clangd #4135

Merged
merged 4 commits into from
Jul 25, 2024

Conversation

brymer-meneses
Copy link
Contributor

This PR adds a note on how to generate compile_commands.json which is necessary for having clangd generate accurate diagnostics

Copy link

google-cla bot commented Jul 15, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@github-actions github-actions bot requested a review from jonmeow July 15, 2024 20:16
@github-actions github-actions bot added the documentation An issue or proposed change to our documentation label Jul 15, 2024
docs/project/contribution_tools.md Outdated Show resolved Hide resolved
docs/project/contribution_tools.md Outdated Show resolved Hide resolved
Copy link
Contributor

@jonmeow jonmeow left a comment

Choose a reason for hiding this comment

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

Thanks! This seems like a good thing to have documented.

docs/project/contribution_tools.md Outdated Show resolved Hide resolved
docs/project/contribution_tools.md Outdated Show resolved Hide resolved
@brymer-meneses
Copy link
Contributor Author

I have also added a note telling the user that python3 should be installed on their system.

Copy link
Contributor

@jonmeow jonmeow left a comment

Choose a reason for hiding this comment

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

Thanks!

@jonmeow jonmeow enabled auto-merge July 25, 2024 16:38
@jonmeow jonmeow added this pull request to the merge queue Jul 25, 2024
Merged via the queue into carbon-language:trunk with commit 70c20be Jul 25, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An issue or proposed change to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants