asc/cmba-bylaws
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 17 Wiki Activity

Implement spell-check (and spell check existing)

Browse Source 
commit c81148c7d6ab9f0d01499945f87e8a632b46c37c
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 12:44:22 2024 -0600

    ignore git-spell-check temp files

commit 66fe77de453aa758b1122f821e1d3e99557516eb
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 12:43:05 2024 -0600

    add checking for header in pws

commit e7659d2442382c71e683596f77b32cc3f3a46bb2
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 12:29:40 2024 -0600

    spell-check files

commit 44081a0c148cf30627191a5ff5acaed704785b04
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 12:27:41 2024 -0600

    implement spell-check
This commit is contained in:
Anthony Correa
2024-01-19 12:47:54 -06:00
parent abc2f087ba
commit 7f8da89e86
7 changed files with 248 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -43,7 +43,7 @@ were `{format}` is one of the below:
## Markdown formatting
- `#` or `h1` is used for either "Consitution" or "Bylaws". They are not numbered, necessitating an `{.unnumbered}` class.
- `#` or `h1` is used for either "Constitution" or "Bylaws". They are not numbered, necessitating an `{.unnumbered}` class.
- Note: to get the numbering to match existing convention, a [Lua filter](https://github.com/jgm/pandoc/issues/5071#issuecomment-856918980) was required, see [jgm/pandoc#5701](https://github.com/jgm/pandoc/issues/5071)
- `##` or `h2` is used for sections
- `###` or `h3` is used for subsections
@@ -54,10 +54,24 @@ Metadata is stored in the `metadata.yml` file.
## Project history
The constitution and bylaws were modernized in 2021, using Google Docs. This project brings that effort into Git and Github. Previous commits show a generated plaintext history of the changes prior to this project (thanks to [gitdriver](https://github.com/larsks/gitdriver)), with the first being the version from 2016.
The constitution and bylaws were modernized in 2021, using Google Docs. This project brings that effort into Git and Github. Previous commits show a generated plain-text history of the changes prior to this project (thanks to [gitdriver](https://github.com/larsks/gitdriver)), with the first being the version from 2016.
## Spell-checking
Spell-checking is performed on the pre-commit via [.spell-check/git-spell-check](.spell-check/git-spell-check) (courtesy of [mprpic/git-spell-check](https://github.com/mprpic/git-spell-check))
You can manually run spell-checking of all markdown files by running the script (requires [aspell](http://aspell.net)):
```console
./.spell-check/spell-check
```
Should you want to bypass the pre-commit hook (though not recommended), you can commit with
```console
git commit --no-verify".
```
## To-Do
- [ ] Spell Checking
- [X] Spell Checking
- [ ] Remove dependence on make, verify Windows support
## About the CMBA