Add no verify for commit with documentation #454
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update master
Signed-off-by: Agora Security <github@agora-security.com>
Signed-off-by: Agora Security <github@agora-security.com>
Signed-off-by: Agora Security <github@agora-security.com>
In git commit, add:
-n, --no-verify
This option bypasses the pre-commit and commit-msg hooks. See also githooks(5).
Signed-off-by: Agora@Ubuntu-dev <filter@agora-security.com>
Signed-off-by: Agora Security <github@agora-security.com>
1ebf798 to
edd2c1f
Compare
| # :no_verify | ||
| # | ||
| # @param [String] message the commit message to be used | ||
| # @param [Array] opts the commit options to be used |
There was a problem hiding this comment.
YARD comes with support for annotating option hashes:
Suggested change
| # @param [Array] opts the commit options to be used | |
| # @param [Hash] opts the commit options to be used | |
| # @option opts [Boolean] :amend | |
| # @option opts [Boolean] :all | |
| # @option opts [Boolean] :allow_empty | |
| # @option opts [String] :author | |
| # @option opts [String] :date | |
| # @option opts [Boolean] :no_verify |
There was a problem hiding this comment.
I agree with @olleolleolle but I am planning on adding proper yard docs across the board and will fix this then.
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Your checklist for this pull request
🚨Please review the guidelines for contributing to this repository.
Description
Add option to bypasses the pre-commit and commit-msg hooks
Improved PR of #426