[ { "path": ".gitattributes", "content": "CRLF.md text eol=crlf\nCR.md text eol=cr\n\nfixtures/** linguist-vendored=true\nfeatures/** linguist-vendored=true\ntestdata/** linguist-vendored=true\n" }, { "path": ".github/CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\njdkato@vale.sh.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n" }, { "path": ".github/CONTRIBUTING.md", "content": "# Contributing to Vale\n\nInterested in contributing to Vale? Great—we welcome contributions of any kind including documentation improvements, bug reports, feature requests, and pull requests.\n\n## Table of Contents\n\n- [Contributing to Vale](#contributing-to-vale)\n - [Table of Contents](#table-of-contents)\n - [Introduction](#introduction)\n - [Testing](#testing)\n - [Setting up a Development Environment](#setting-up-a-development-environment)\n - [Code Contribution Guidelines](#code-contribution-guidelines)\n - [Git Commit Message Guidelines](#git-commit-message-guidelines)\n - [Terminology](#terminology)\n\n## Introduction\n\nVale is a natural language linter that supports plain text, markup (Markdown, reStructuredText, AsciiDoc, and HTML), and source code comments. However, unlike many similar projects, Vale's primary focus isn't on providing a collection of rules everyone must follow—instead, Vale aims to be flexible enough to support many different styles (see [Styles](https://errata-ai.github.io/vale/styles/) for more information).\n\nMore specifically, Vale is written in Go and split into packages that are tasked with implementing specific functionality:\n\n- `check` handles the loading and validating of external rules (YAML files).\n- `core`: includes the main structures used throughout the application (e.g., `File` and `Alert`) and manages configuration files.\n- `lint` handles the actual linting, which includes knowing when to apply rules and how to handle specific file formats.\n- `rule` implements Vale's built-in style.\n- `ui` manages displaying information to users.\n\nIf you're looking to improve Vale's documentation, check out the [`docs/`](https://github.com/errata-ai/vale/tree/master/docs) directory.\n\n## Testing\n\nVale is tested using both integration and unit tests.\n\nIntegration tests are the most plentiful at the moment. They're implemented using the behavior-driven development framework [Cucumber](https://cucumber.io/). You'll find the relevant files for these tests in the `fixtures` and `features` directories. Unit tests are found in the `*_test.go` files inside the actual Go packages.\n\nWe also track Vale's performance on a per-commit basis through benchmarks. On every commit, you'll see comparison against the last tagged release (over 5 runs) on CI builds:\n\n```text\nLintRST-2 1.63s ± 2% 1.65s ± 2% +0.95% (p=0.031 n=10+10)\nLintMD-2 1.54s ± 1% 1.54s ± 1% ~ (p=0.604 n=10+10)\n```\n\n\nTo run the tests, you'll want to invoke either `make bench` or `make ci` (see [Setting up a Development Environment]() for more information).\n\n## Setting up a Development Environment\n\nPrerequisites:\n\n* [Ruby](https://www.ruby-lang.org/en/downloads/) (v2.3+)\n* [Go](https://golang.org/) (v1.7+) installed.\n* [Asciidoctor](http://asciidoctor.org/) available on your `$PATH`.\n* [rst2html](http://docutils.sourceforge.net/docs/user/tools.html#rst2html-py) available on your `$PATH`. The latter is installed with both [Sphinx](http://www.sphinx-doc.org/en/stable/) and [docutils](https://pypi.python.org/pypi/docutils).\n* [xsltproc](http://xmlsoft.org/xslt/xsltproc.html) available on your `$PATH`.\n* [dita](https://www.dita-ot.org/download) available on your `$PATH` (v3.6+).\n\n```bash\n$ gem install bundler:2.2.31 # if necessary\n$ make setup\n$ make test\n```\n\n## Code Contribution Guidelines\n\nTo make the contribution process as seamless as possible, we ask for the following:\n\n* Fork the project and make your changes.\n* When you’re ready to create a pull request, be sure to:\n * Run `make lint` to check your Go code style.\n * Squash your commits into a single commit. `git rebase -i`. It’s okay to force update your pull request with `git push -f`.\n * Follow the **Git Commit Message Guidelines** below.\n\n## Git Commit Message Guidelines\n\nVale follows a modified version of the [AngularJS Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines). A commit message should take the following form:\n\n```\n: \n\n\n\n