Skip to content

include vale for documentation enhancement #23

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

Merged
merged 3 commits into from
Jun 21, 2022
Merged

Conversation

Revathyvenugopal162
Copy link
Collaborator

@Revathyvenugopal162 Revathyvenugopal162 commented Jun 20, 2022

What is vale?

Vale is a tool to automatically lint PRs of Markdown files to ensure they follow a vocabulary style guide and uses GitHub Checks API to highlight errors on the line numbers directly on the PR for contextual feedback.

configuration

  • .vale.ini file is in doc folder.
  • style guide using here is Google. more style guides here.

@github-actions github-actions bot added documentation Improvements or additions to documentation maintenance Package and maintenance related CI/CD labels Jun 20, 2022
@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review June 20, 2022 12:54
@github-actions github-actions bot added CI/CD and removed CI/CD labels Jun 20, 2022
MaxJPRey
MaxJPRey previously approved these changes Jun 20, 2022
@github-actions github-actions bot added CI/CD and removed CI/CD labels Jun 20, 2022
@Revathyvenugopal162 Revathyvenugopal162 merged commit bc64472 into main Jun 21, 2022
@Revathyvenugopal162 Revathyvenugopal162 deleted the docs/add-vale branch June 21, 2022 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants