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

Add new documentation about the pre-commit hook #9094

Merged
merged 1 commit into from
Apr 15, 2024

Conversation

kaixin-hc
Copy link
Contributor

@kaixin-hc kaixin-hc commented Mar 13, 2024

Fixes #9063

Aside from updating the specific sections flagged in the issue, I moved the pre-commit hook from under the manual install to above the manual install for clang-format. My thought process was that the new pre-commit workflow automatically installs the right version of clang-format; since that seems to be an issue warranting a note in the manual install section, rearranging it such that the pre-commit recommendation is suggested first made sense to me.

@kaixin-hc kaixin-hc force-pushed the update_pre-commit branch 2 times, most recently from 31680e2 to 9902d0c Compare March 13, 2024 18:43
@Calinou Calinou added enhancement area:contributing Issues and PRs related to the Contributing/Development section of the documentation labels Mar 13, 2024
@mhilbrunner mhilbrunner requested a review from akien-mga March 14, 2024 22:55
@kaixin-hc
Copy link
Contributor Author

@AThousandShips @mhilbrunner

Seeing @Chubercik 's PR updating to remove references to Black, shall we KIV the formatting question around if black should be formatted or capitalised? To be consistent I've returned all clang-format mentions to be unformatted as well. Let me know if there's anything else I can do!

@mhilbrunner
Copy link
Member

mhilbrunner commented Apr 14, 2024

Yeah, I don't think that matters too much or has the highest priority right now. We should get this merged so people have docs they can look at for the change (and thanks for taking care of it).

Would be nice if you could squash the commits if you feel comfortable with that.

I'll see if I can get Rémi to review this on monday as he IIRC implemented the change and may spot stuff I don't, otherwise, I'll just merge as is :) Thanks again!

@kaixin-hc
Copy link
Contributor Author

Squashed it! Thanks for the reminder and sorry for missing it :)

@AThousandShips AThousandShips merged commit 29de6ef into godotengine:master Apr 15, 2024
1 check passed
@AThousandShips
Copy link
Member

Thank you! And congratulations on your first merged contribution! 🎉

@kaixin-hc kaixin-hc deleted the update_pre-commit branch April 16, 2024 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update how to use pre-commit
6 participants