From 89a9aefb6039f158b8613f9d7ba0d11d141d6ba2 Mon Sep 17 00:00:00 2001 From: Subhajit Sahu Date: Mon, 17 Feb 2025 21:17:55 +0530 Subject: [PATCH] MAINT: adding spell-check using typos in CI pipeline --- .github/workflows/github-ci.yaml | 3 +++ .typos.toml | 4 ++++ docs/meta/project-governance.md | 4 ++-- 3 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 .typos.toml diff --git a/.github/workflows/github-ci.yaml b/.github/workflows/github-ci.yaml index e4d21b4..9be6178 100644 --- a/.github/workflows/github-ci.yaml +++ b/.github/workflows/github-ci.yaml @@ -76,6 +76,9 @@ jobs: echo `ruff --version` ruff check pdfly/ + - name: Spell Check Repo + uses: crate-ci/typos@v1.29.7 + package: name: Build & verify package runs-on: ubuntu-latest diff --git a/.typos.toml b/.typos.toml new file mode 100644 index 0000000..6bbb68f --- /dev/null +++ b/.typos.toml @@ -0,0 +1,4 @@ +[default] +extend-ignore-identifiers-re = [ + "FlateDecode", +] diff --git a/docs/meta/project-governance.md b/docs/meta/project-governance.md index a2ed94d..e88523b 100644 --- a/docs/meta/project-governance.md +++ b/docs/meta/project-governance.md @@ -18,7 +18,7 @@ tool. request, but that is up to the maintainer. Other contributors describe issues, help to ask questions on existing issues to make them easier to answer, participate in discussions, and help to improve the documentation. Contributors - are similar to maintainers, but without technial permissions. + are similar to maintainers, but without technical permissions. * A **user** is a person who imports pdfly into their code. All pdfly users are developers, but not developers who know the internals of pdfly. They only use the public interface of pdfly. They will likely have less knowledge about @@ -102,7 +102,7 @@ An issue is any technical description that aims at bringing pdfly forward: * Performance tickets: pdfly could be faster - let us know about your specific scenario. -Any comment that is in those technial descriptions which is not helping the +Any comment that is in those technical descriptions which is not helping the discussion can be deleted. This is especially true for "me too" comments on bugs or "bump" comments for desired features. People can express this with 👍 / 👎 reactions.