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

Document Git Hooks and create a troubleshooting guide #2360

Closed
macgills opened this issue Sep 4, 2020 · 4 comments · Fixed by #3798
Closed

Document Git Hooks and create a troubleshooting guide #2360

macgills opened this issue Sep 4, 2020 · 4 comments · Fixed by #3798
Assignees
Milestone

Comments

@macgills
Copy link
Contributor

macgills commented Sep 4, 2020

Is your feature request related to a problem? Please describe.
The git hooks are a pain point for new contributors.

Describe the solution you'd like
Explain detekt, ktlint and committing with --no-verify and link this page from the git hook failure message

@s-ayush2903
Copy link
Contributor

So this Issue does not need any Pull Request, just documenting here about the aforementioned and putting the url of this issue in pre-commit.sh will do the required, is it like that or something else?

@macgills
Copy link
Contributor Author

macgills commented Sep 9, 2020

It will probably entail a PR to add a markdown file but yes that is the file to be edited with the link

@stale
Copy link

stale bot commented Dec 4, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be now be reviewed manually. Thank you for your contributions.

@stale stale bot added the stale label Dec 4, 2020
@kelson42 kelson42 added this to the 3.8.0 milestone Dec 29, 2022
@stale stale bot removed the stale label Dec 29, 2022
@stale stale bot removed the stale label Dec 29, 2022
@kelson42 kelson42 modified the milestones: 3.13.0, 3.10.0 Apr 17, 2024
@kelson42
Copy link
Collaborator

@MohitMaliFtechiz Please create a dedicated section in the CONTRIBUTING file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants