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.

Sign up for GitHub

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

Jump to bottom

docs: improve pre-commit docs and discoverability when CI fails #29970

Merged
merged 7 commits into from
Aug 20, 2024
Merged

docs: improve pre-commit docs and discoverability when CI fails #29970

merged 7 commits into from
Aug 20, 2024

Conversation

mistercrunch
Copy link
Member

@mistercrunch mistercrunch commented Aug 20, 2024 •
edited
Loading

Many first-time contributors don't set up pre-commit for some reason (they're probably using a docker-compose backed dev env setup), so it's a common point of confusion when CI fails for linting or minor glitches. This PR:

  • adds a clear message about what is failing and why
  • give a pointer to pre-commit
  • points to the [now improved] docs for more details

Fancy emojis and all ->
Screenshot 2024-08-20 at 9 13 06 AM

@github-actions github-actions bot added doc Namespace | Anything related to documentation github_actions Pull requests that update GitHub Actions code labels Aug 20, 2024
@mistercrunch mistercrunch mentioned this pull request Aug 20, 2024
Open
9 tasks
@rusackas rusackas requested a review from sfirke August 20, 2024 02:14
@mistercrunch mistercrunch merged commit 175ba78 into master Aug 20, 2024
35 checks passed
@mistercrunch mistercrunch deleted the pre-commit-docs branch August 20, 2024 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rusackas rusackas rusackas approved these changes

@villebro villebro Awaiting requested review from villebro villebro is a code owner

@geido geido Awaiting requested review from geido geido is a code owner

@eschutho eschutho Awaiting requested review from eschutho eschutho is a code owner

@betodealmeida betodealmeida Awaiting requested review from betodealmeida betodealmeida is a code owner

@nytai nytai Awaiting requested review from nytai nytai is a code owner

@craig-rueda craig-rueda Awaiting requested review from craig-rueda craig-rueda is a code owner

@john-bodley john-bodley Awaiting requested review from john-bodley john-bodley is a code owner

@kgabryje kgabryje Awaiting requested review from kgabryje kgabryje is a code owner

@dpgaspar dpgaspar Awaiting requested review from dpgaspar dpgaspar is a code owner

@sfirke sfirke Awaiting requested review from sfirke

Assignees
No one assigned
Labels
doc Namespace | Anything related to documentation github_actions Pull requests that update GitHub Actions code preset-io size/M
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mistercrunch @rusackas