Skip to content

Commit d4b5d61

Browse files
authored
Merge pull request #3 from frc6506/initial_patches
Initial patches 3
2 parents 87b49bb + 23f27a2 commit d4b5d61

File tree

5 files changed

+30
-8
lines changed

5 files changed

+30
-8
lines changed

.vscode/extensions.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"recommendations": [
33
"bierner.github-markdown-preview",
44
"DavidAnson.vscode-markdownlint",
5+
"earshinov.permute-lines",
56
"streetsidesoftware.code-spell-checker"
67
]
7-
}
8+
}

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
Please note that team wide, school, district, and FIRST policies supersede
44
this document should they conflict.
5-
65
## Our Pledge
76

87
We as members, contributors, and leaders pledge to make participation in our
@@ -122,6 +121,8 @@ the community.
122121

123122
## Attribution
124123

124+
> Adapted from [frc6506/docs](https://github.com/frc6506/docs/blob/master/CODE_OF_CONDUCT.md), which contained the below message:
125+
125126
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
126127
version 2.0, available at
127128
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

CONTRIBUTING.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Contributing
22

3+
> Adapted from [frc6506/docs](https://github.com/frc6506/docs/blob/master/CONTRIBUTING.md
4+
35
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.
46

57
## Issues
@@ -10,12 +12,14 @@ Check out the issues list
1012

1113
## Spellcheck
1214

13-
![Spellcheck Action](https://github.com/frc6506/docs/workflows/Spellcheck%20Action/badge.svg)
15+
[![Spellcheck Action](https://github.com/frc6506/frc6506.github.io/actions/workflows/spell.yml/badge.svg)](https://github.com/frc6506/frc6506.github.io/actions/workflows/spell.yml)
1416

1517
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.
1618

1719
### Word Whitelist
1820

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+
1923
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.
2024

2125
## Markdown Information
@@ -26,10 +30,10 @@ The word white list is located at `.github/workflows/config/.wordList.txt`. Ple
2630

2731
## Markdown
2832

29-
[![Markdown Linter](https://github.com/frc6506/docs/actions/workflows/markdownwonLinter.yml/badge.svg)](https://github.com/frc6506/docs/actions/workflows/markdownwonLinter.yml)
33+
[![Markdown Linter](https://github.com/frc6506/frc6506.github.io/actions/workflows/markdownwonLinter.yml/badge.svg)](https://github.com/frc6506/frc6506.github.io/actions/workflows/markdownwonLinter.yml)
3034
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.
3135

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.
3337

3438
### Rules
3539

@@ -52,6 +56,10 @@ Nonprofits get free space, but the compress images action should be running anyw
5256

5357
## Generic Information of about GitHub Pages
5458

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+
5563
[Basic Overview of what GitHub pages is](https://pages.github.com/)
5664

5765
[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
6068

6169
<br>
6270

63-
_Updated 202100510T1700 PDT_
71+
_Updated 20220206T1230 PT_

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
11
# frc6506.github.io
2-
Root website for frc6506.github.io .
2+
3+
Landing page for frc6506.github.io .
4+
5+
[![Spellcheck Action](https://github.com/frc6506/frc6506.github.io/actions/workflows/spell.yml/badge.svg)](https://github.com/frc6506/frc6506.github.io/actions/workflows/spell.yml)
6+
[![Markdown Linter](https://github.com/frc6506/frc6506.github.io/actions/workflows/markdownwonLinter.yml/badge.svg)](https://github.com/frc6506/frc6506.github.io/actions/workflows/markdownwonLinter.yml)
7+
[![Compress images](https://github.com/frc6506/frc6506.github.io/actions/workflows/imageActions.yml/badge.svg)](https://github.com/frc6506/frc6506.github.io/actions/workflows/imageActions.yml)
8+
[![pages-build-deployment](https://github.com/frc6506/frc6506.github.io/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/frc6506/frc6506.github.io/actions/workflows/pages/pages-build-deployment)
9+
10+
If you would like to help, see [CONTRIBUTING.md]([CONTRIBUTING.md](https://github.com/frc6506/frc6506.github.io/blob/main/CONTRIBUTING.md)
11+
12+
<br>
13+
14+
_Updated 20220206T1230 PT_

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Hello, and welcome to the landing page for the Steel Boot programming team! Thi
2020

2121
[Instagram](https://www.instagram.com/frcteam6506/)
2222

23-
[Email](mailto://FRCteam6506@gmail.com)
23+
[Email](mailto:FRCteam6506@gmail.com)
2424

2525
[YouTube](https://www.youtube.com/channel/UCAoZ07GCdY7k6SkPM58Gm-A)
2626

0 commit comments

Comments
 (0)