We have adopted Vale to improve the quality and consistency of our written content across the company. This repository contains a custom Vale package designed to enforce style guidelines and maintain clear, consistent writing. In this repository you will find all the necessary resources to integrate it into your workflow.
You can find more information about Vale here: vale.sh
To use this package:
- Place the files from the
usagedirectory in the root of your repository - Replace
<package>in the link to the Vale package with the correct name (websiteorgithub) - Execute the respective commands as commented in the
usage/.vale.inifile.
To update these packages, start by updating the files in the respective directories. Once you are satisfied with the package content, create a zip archive using the following command:
export RELEASE_TAG=<tag>
cd packages
zip -r general.zip general
zip -r website.zip website
zip -r github.zip github
gh release upload $RELEASE_TAG general.zip website.zip github.zip --clobber
rm -rf general.zip website.zip github.zipAfter obtaining the zip archive, create a GitHub Release in this repository and attach your new zip archives.
Note: Once you have finished, please ensure to update the release tag in github/.vale.ini, website/.vale.ini and usage/.vale.ini to the one you just created.
We value your feedback and suggestions! If you have any ideas or want to report issues, please create an issue. Additionally, you can submit your contributions by opening a pull request.
Copyright © 2024 LiveWyer, Licensed under the MIT License; you may not use this file except in compliance with the License.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.