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

Introduce rst linting via precommit hook #74

Merged
merged 4 commits into from
Aug 2, 2022

Conversation

AlpAribal
Copy link
Contributor

Description

Adds the doc8 precommit hook to lint rst files and fixes warnings it produces.

Also removes terraform and sqlfluff precommit hooks, since there are no terraform or sql files in the repo.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring including code style reformatting
  • Other (please describe):

Checklist:

  • I have read the contributing guideline doc (external contributors only)
  • Lint and unit tests pass locally with my changes
  • I have kept the PR small so that it can be easily reviewed
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • All dependency changes have been reflected in the pip requirement files.

AlirezaSohofi
AlirezaSohofi previously approved these changes Jul 29, 2022
Copy link
Contributor

@AlirezaSohofi AlirezaSohofi left a comment

Choose a reason for hiding this comment

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

This is great, thanks a lot Alp!

Base automatically changed from alp-docs-work to main August 2, 2022 08:11
Copy link
Contributor

@AlirezaSohofi AlirezaSohofi left a comment

Choose a reason for hiding this comment

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

👍

@AlpAribal AlpAribal merged commit 1b9e1e6 into main Aug 2, 2022
@AlpAribal AlpAribal deleted the alp-introduce-rst-linting branch August 2, 2022 11:42
@github-actions github-actions bot locked and limited conversation to collaborators Aug 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants