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

Better explanation for multiple commands in the Hooks section of the README #143

Merged
merged 2 commits into from
Mar 25, 2021

Conversation

Mastermindaxe
Copy link
Contributor

@Mastermindaxe Mastermindaxe commented Feb 1, 2021

Changes

  • Added a better explanation for multiple commands in hooks
  • Minor formatting of the markdown file (Removal of trailing whitespaces)

Related Issues

- Better explanation for multiple commands in Hooks in the README.md
@Mastermindaxe
Copy link
Contributor Author

I'm not sure if we should just enhance the example with a command that uses && for command chaining. What do you think?

- Minor changes like removing trailing whitespaces and such
@calebcartwright
Copy link
Member

I'm not sure if we should just enhance the example with a command that uses && for command chaining. What do you think?

I'd like to include this up above in the examples under the Configuration section.

Maybe we could change from this:

[hooks]
pre-commit = "cargo test"
prepare-commit-msg = "do-something && then-do-something-else"
# Array syntax for multiple hooks available in v0.12.0+
pre-push = ["cargo check", "cargo fmt -- --check"]
post-commit = "echo yay"


...

@codecov
Copy link

codecov bot commented Feb 2, 2021

Codecov Report

Merging #143 (f3fb029) into master (e284e15) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #143   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          144       142    -2     
=========================================
- Hits           144       142    -2     
Impacted Files Coverage Δ
src/git.rs 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e284e15...f3fb029. Read the comment docs.

Copy link
Member

@calebcartwright calebcartwright left a comment

Choose a reason for hiding this comment

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

Going to go ahead and merge to get some of the changes pushed through since this topic keeps popping up with users. Will augment the docs myself afterwards.

Thanks again!

@calebcartwright calebcartwright merged commit 519aa00 into swellaby:master Mar 25, 2021
@Mastermindaxe Mastermindaxe deleted the issue-fix/#137 branch February 15, 2023 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants