You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Contributing
2
2
3
+
> Adapted from [frc6506/docs](https://github.com/frc6506/docs/blob/master/CONTRIBUTING.md
4
+
3
5
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.
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](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) can help to catch misspelled words.
16
18
17
19
### Word Whitelist
18
20
21
+
> The word whitelist was adapted from [frc6506/docs - extension settings](https://github.com/frc6506/docs/blob/master/.vscode/settings.json) and [frc6506/docs - spell check action word list](https://github.com/frc6506/docs/blob/master/.github/workflows/config/.wordList.txt)
22
+
19
23
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](https://marketplace.visualstudio.com/items?itemName=earshinov.permute-lines) adds the command `Sort Lines Ascending` to the Commands Pallet ([Ctrl] + [Shift] + [P]) for easier sorting.
20
24
21
25
## Markdown Information
@@ -26,10 +30,10 @@ The word white list is located at `.github/workflows/config/.wordList.txt`. Ple
An automatic markdown linter inspects the all markdown files. You can use the VS Code extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) to help you out in VS Code.
31
35
32
-
Also checkout the VS Code extension [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) for live preview in VS Code.
36
+
Also checkout the VS Code extension [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) for a live preview in VS Code.
33
37
34
38
### Rules
35
39
@@ -52,6 +56,10 @@ Nonprofits get free space, but the compress images action should be running anyw
52
56
53
57
## Generic Information of about GitHub Pages
54
58
59
+
> More information will be added on our [documentation website](https://frc6506.github.io/docs/)
60
+
61
+
> The version of this file on our [documentation website](https://github.com/frc6506/docs/blob/master/CONTRIBUTING.md) may be more up to date
62
+
55
63
[Basic Overview of what GitHub pages is](https://pages.github.com/)
56
64
57
65
[Introduction to Jekyll](https://help.github.com/en/github/working-with-github-pages/setting-up-a-github-pages-site-with-jekyll)
@@ -60,4 +68,4 @@ Nonprofits get free space, but the compress images action should be running anyw
0 commit comments