From 1d1957055bd2c421a850faeb66a98a3d100f2eff Mon Sep 17 00:00:00 2001 From: "sweep-ai[bot]" <128439645+sweep-ai[bot]@users.noreply.github.com> Date: Tue, 26 Dec 2023 20:17:27 +0000 Subject: [PATCH] feat: Updated CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2015635..1511354 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -312,7 +312,7 @@ Please obey the following rules to better format the docs, which would greatly i 5. Please use the correct case for technical terms, such as using `HTTP` instead of http, `MySQL` rather than mysql, `Kubernetes` instead of kubernetes, etc. 6. Please check if there's any typos in the docs before submitting PRs. -## Engage to help anything +## Typo Checker Tool\n\n`typos` is a fast source code spell checker that helps to identify and correct typos in your source code. It is integrated into the GitHub Actions workflow to ensure the quality of contributions by automatically detecting typographical errors.\n\n### Installing `typos`\n\nTo install the `typos` tool on your local machine, run the `install_typos.sh` script located in the `scripts` directory. This script will download the tool and place it in the `tools` directory for use.\n\n```bash\n./scripts/install_typos.sh\n```\n\nPlease make sure to run the typo checker before submitting your pull request as any typographical errors detected by the tool will result in a failed check.\n\n## Engage to help anything We choose GitHub as the primary place for github-label-syncer to collaborate. So the latest updates of github-label-syncer are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.