chore: update documentation, add pre-commit workflow#48
Open
burigolucas wants to merge 3 commits into
Open
Conversation
387e513 to
4f3837b
Compare
25a736b to
5896f8b
Compare
5896f8b to
f9dc74b
Compare
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
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.
Description
This PR adds a new workflow to run the pre-commit hooks on every PR (internal and external) to ensure commits satisfy the pre-commit hook configuration in case the contributor has not enabled it locally. In addition, the pre-commit hooks now include a hook to update the documentation and check whether it is up-to-date. This should avoid out-dated documentation landing in the main branch.
Type of Change
Pull Request Title