Contributing
First, please note that you will need to create your own branch or fork as the master branch is protected. Creating your own workspace helps prevents conflicts and gives the various GitHub Actions time to inspect your work before you work goes live.
Issues
Check out the issues list
Pull Requests
Spellcheck
An automatic spell checker runs as a GitHub Action. Note that at this time, there are no other writing inspectors used. Although slightly finicky, the VS Code extension Code Spell Checker can help to catch misspelled words.
Word Whitelist
The word white list is located at .github/workflows/config/.wordList.txt. Please keep it neatly formatted in alphabetical order. The VS Code extension Permute Lines adds the command Sort Lines Ascending to the Commands Pallet ([Ctrl] + [Shift] + [P]) for easier sorting.
Markdown Information
Markdown
An automatic markdown linter inspects the all markdown files. You can use the VS Code extension markdownlint to help you out in VS Code.
Also checkout the VS Code extension Markdown Preview Enhanced for a live preview in VS Code.
Rules
Ignored Rules - and Current Implementation
MD013 - The line length is ignored. It is recommend you enable word wrap.
MD028 - Two separate block quotes may now be placed next to each other.
MD029 - Numbered lists may either use all 1s as number place holders or actually number the lists in order.
MD033 - Inline HTML is currently permitted, but please avoid using it too much.
MD036 - Allow top level text to be emphasized, even when not part of a paragraph. Headings should still use the normal pound sign (#) designation, but this allows the italics updated on line to not be flagged.
Compress Images
Nonprofits get free space, but the compress images action should be running anyways.
Generic Information of about GitHub Pages
A derivative of this file is also used at frc6506.github.io
Basic Overview of what GitHub pages is
Basic Overview of how this repository is setup
List of Contributors
Author: @BobSaidHi Edits: @CTZxVULKAN, @BobinMathew Apps: dependabot, github-actions Github Actions: actions/checkout, avtodev/markdown-lint, calibreapp/image-actions, rojopolis/spellcheck-github-actions
Updated 20220312 PDT