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

Add Vale linter for style checking #60

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

scott-klaytn
Copy link
Collaborator

Proposed changes

  • Add Vale linter for automatic style checking to enforce consistent writing standards across all KIPs. It will run on every PR and provide suggestions, warnings and error based on pre-defined style rules
    • Google Developer Documentation Style Guide and Proslint style integrated
    • Kaia-specific rules added
      image

Types of changes

Please put an x in the boxes related to your change.

  • Bugfix
  • KIP Proposal
  • KIP Improvement

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • Used the suggested template: https://github.com/kaiachain/KIPs/blob/main/kip-template.md
  • I have read the CLA and signed by comment I have read the CLA Document and I hereby sign the CLA in first time contribution
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Related issues

Related to Kaia Docs PRs (#261, #266)

Further comments

@scott-klaytn
Copy link
Collaborator Author

I have read the CLA Document and I hereby sign the CLA

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.

1 participant