Skip to content

Commit 0ab8c3d

Browse files
Format code with prettier
This commit fixes the style issues introduced in 6fb45c3 according to the output from prettier. Details: https://deepsource.io/gh/Dog-Face-Development/DFD-Code-Style-Guide/transform/a5665cfc-99ea-4ab3-a499-c7928bd9b8db/
1 parent 6fb45c3 commit 0ab8c3d

11 files changed

+1495
-593
lines changed

CODE_OF_CONDUCT.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
2424
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
25+
- Focusing on what is best not just for us as individuals, but for the
2626
overall community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or
30+
- The use of sexualized language or imagery, and sexual attention or
3131
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
3535
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
- Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
106106
### 4. Permanent Ban
107107

108108
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
109+
standards, including sustained inappropriate behavior, harassment of an
110110
individual, or aggression toward or disparagement of classes of individuals.
111111

112112
**Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Please contribute using [GitHub Flow](https://guides.github.com/introduction/flo
5454
### Do you have questions about the source code?
5555

5656
- Ask any question about how to use the Style Guides on our [Discord](https://discord.gg/73azSgcNYt).
57-
- If it does not get answered, open an [issue](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues/new/choose).
57+
- If it does not get answered, open an [issue](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues/new/choose).
5858

5959
## Coding Conventions
6060

LICENSE.md

+242-242
Large diffs are not rendered by default.

README.md

+124-124
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,124 @@
1-
<!-- Logo -->
2-
<h1 align="center">
3-
<img src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/images/logo.png" height="250px" width="300px" alt="Code Style Guide">
4-
<br>
5-
Dog Face Development Co. Code Style Guide
6-
</h1>
7-
8-
<!-- Copy -->
9-
<h4 align="center">The Dog Face Development Co. Code Style Guide, published as Markdown files and as a web page.</h4>
10-
11-
<!-- Badges -->
12-
<div align="center">
13-
<!-- Stability -->
14-
<img alt="Docker State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/docker-publish.yml/badge.svg">
15-
<!-- Stability -->
16-
<img alt="GitHub Pages State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/pages-build-deployment.yml/badge.svg">
17-
<!-- CodeQL -->
18-
<img alt="CodeQL State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/codeql-analysis.yml/badge.svg">
19-
<!-- Version -->
20-
<img alt="GitHub Version" src="https://img.shields.io/github/v/release/Dog-Face-Development/DFD-Code-Style-Guide?include_prereleases">
21-
<!-- Issues -->
22-
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/Dog-Face-Development/DFD-Code-Style-Guide">
23-
<!-- Pull Requests -->
24-
<img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/Dog-Face-Development/DFD-Code-Style-Guide">
25-
<!-- Discord -->
26-
<img alt="Discord Server ID" src="https://img.shields.io/discord/1016106655450140783">
27-
<!-- Language Count -->
28-
<img alt="GitHub Languages" src="https://img.shields.io/github/languages/count/Dog-Face-Development/DFD-Code-Style-Guide">
29-
</div>
30-
31-
<!-- Navigation -->
32-
<p align="center">
33-
<a href="#key-features">Key Features</a> •
34-
<a href="#how-to-use">How To Use</a> •
35-
<a href="#contributing">Contributing</a> •
36-
<a href="#credits">Credits & Contributors</a>
37-
</p>
38-
39-
## Key Features
40-
41-
* Clear style guide.
42-
* Available for many programming languages.
43-
* Available for many programming platforms.
44-
* Consistency across all projects.
45-
* Easy to implement.
46-
* Reusable standards.
47-
* Available in Markdown and on the web.
48-
* Cross platform, web browser based.
49-
50-
## How To Use
51-
52-
**To access the latest version of the website visit it at [https://dog-face-development.github.io/DFD-Code-Style-Guide/](https://dog-face-development.github.io/DFD-Code-Style-Guide/).**
53-
54-
**To clone and run your own copy of this website**, you'll need [Git](https://git-scm.com/downloads) installed on your computer. If you would rather not use Git, you can just download the code from GitHub above. From your command line:
55-
56-
```bash
57-
# Clone this repository
58-
$ git clone https://github.com/Dog-Face-Development/DFD-Code-Style-Guide.git
59-
60-
# Go into the repository
61-
$ cd DFD-Code-Style-Guide
62-
63-
# Run the webpage
64-
$ index.html
65-
```
66-
67-
You can also pull the [Docker](https://www.docker.com/) image from GitHub Packages. From your command line:
68-
69-
```bash
70-
# Pull image
71-
$ docker pull docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master
72-
73-
# Run container
74-
$ docker run -d -p 8000:80 docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master
75-
76-
# Now, navigate to localhost in your browser to see the webpage
77-
```
78-
79-
If support is required, please open a **[GitHub Discussion](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/discussions)** or join our **[Discord](https://discord.gg/73azSgcNYt)**.
80-
81-
## Contributing
82-
83-
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/compare).
84-
85-
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us (including how to sign our CLA).
86-
87-
## Credits
88-
89-
This software uses the following open source packages, projects, services or websites:
90-
91-
<!-- Credits Table -->
92-
<table>
93-
<tr>
94-
<th align="center"><img src="https://applets.imgix.net/https%3A%2F%2Fassets.ifttt.com%2Fimages%2Fchannels%2F2107379463%2Ficons%2Fmonochrome_large.png?w=240&h=240&s=8a19bbc158996d098e2fb18310ba7f33" width="150" height="150" alt="GitHub"/></th>
95-
<th align="center"><img src="https://pbs.twimg.com/profile_images/1069553420854591489/stZUQMcC_400x400.jpg" width="150" height="150" alt="W3C"/></th>
96-
<th align="center"><img src="https://videos.w3schools.com/files/images/w3schools_logo_500_04AA6D.png" width="150" height="150" alt="W3Schools"/></th>
97-
<th align="center"><img src="https://assets.simpleanalytics.com/press/logo-ratio-1-1/square.svg" width="150" height="150" alt="Simple Analytics"/></th>
98-
</tr>
99-
<tr>
100-
<td align="center">GitHub</td>
101-
<td align="center">W3C</td>
102-
<td align="center">W3Schools</td>
103-
<td align="center">Simple Analytics</td>
104-
</tr>
105-
<tr>
106-
<td align="center"><a href="https://github.com/">Web</a> - <a href="https://github.com/pricing">Plans</a></td>
107-
<td align="center"><a href="https://www.w3.org">Web</a> - <a href="https://www.w3.org/support/">Donate</a></td>
108-
<td align="center"><a href="https://www.w3schools.com">Web</a> - <a href="https://www.w3schools.com/pro/index.php">Pro</a></td>
109-
<td align="center"><a href="https://simpleanalytics.com/?referral=willtheorangeguy">Web</a> - <a href="https://www.simpleanalytics.com/pricing">Plans</a></td>
110-
</table>
111-
112-
## Contributors
113-
114-
* [@willtheorangeguy](https://github.com/willtheorangeguy) - Sponsor on [PayPal](https://paypal.me/wvdg44?country.x=CA&locale.x=en_US)
115-
116-
## You may also like...
117-
118-
* [ProgramVer](https://github.com/Dog-Face-Development/ProgramVer) - An open-source, Python GUI version window to show copyright info and licenses.
119-
* [PyWorkout](https://github.com/Dog-Face-Development/PyWorkout) - A minimal CLI to keep you inspired during your workout!
120-
* [PyAvatar](https://github.com/Dog-Face-Development/PyAvatar) - Easily display all of your creative avatars to keep them consistent across websites.
121-
122-
## License
123-
124-
This project is licensed under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/) - see the [`LICENSE`](LICENSE.md) file for details. See the [Privacy Policy](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/PRIVACY.md), [Terms and Conditions](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/TERMS.md), and [EULA](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/EULA.md) for legal information.
1+
<!-- Logo -->
2+
<h1 align="center">
3+
<img src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/images/logo.png" height="250px" width="300px" alt="Code Style Guide">
4+
<br>
5+
Dog Face Development Co. Code Style Guide
6+
</h1>
7+
8+
<!-- Copy -->
9+
<h4 align="center">The Dog Face Development Co. Code Style Guide, published as Markdown files and as a web page.</h4>
10+
11+
<!-- Badges -->
12+
<div align="center">
13+
<!-- Stability -->
14+
<img alt="Docker State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/docker-publish.yml/badge.svg">
15+
<!-- Stability -->
16+
<img alt="GitHub Pages State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/pages-build-deployment.yml/badge.svg">
17+
<!-- CodeQL -->
18+
<img alt="CodeQL State" src="https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/actions/workflows/codeql-analysis.yml/badge.svg">
19+
<!-- Version -->
20+
<img alt="GitHub Version" src="https://img.shields.io/github/v/release/Dog-Face-Development/DFD-Code-Style-Guide?include_prereleases">
21+
<!-- Issues -->
22+
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/Dog-Face-Development/DFD-Code-Style-Guide">
23+
<!-- Pull Requests -->
24+
<img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/Dog-Face-Development/DFD-Code-Style-Guide">
25+
<!-- Discord -->
26+
<img alt="Discord Server ID" src="https://img.shields.io/discord/1016106655450140783">
27+
<!-- Language Count -->
28+
<img alt="GitHub Languages" src="https://img.shields.io/github/languages/count/Dog-Face-Development/DFD-Code-Style-Guide">
29+
</div>
30+
31+
<!-- Navigation -->
32+
<p align="center">
33+
<a href="#key-features">Key Features</a> •
34+
<a href="#how-to-use">How To Use</a> •
35+
<a href="#contributing">Contributing</a> •
36+
<a href="#credits">Credits & Contributors</a>
37+
</p>
38+
39+
## Key Features
40+
41+
- Clear style guide.
42+
- Available for many programming languages.
43+
- Available for many programming platforms.
44+
- Consistency across all projects.
45+
- Easy to implement.
46+
- Reusable standards.
47+
- Available in Markdown and on the web.
48+
- Cross platform, web browser based.
49+
50+
## How To Use
51+
52+
**To access the latest version of the website visit it at [https://dog-face-development.github.io/DFD-Code-Style-Guide/](https://dog-face-development.github.io/DFD-Code-Style-Guide/).**
53+
54+
**To clone and run your own copy of this website**, you'll need [Git](https://git-scm.com/downloads) installed on your computer. If you would rather not use Git, you can just download the code from GitHub above. From your command line:
55+
56+
```bash
57+
# Clone this repository
58+
$ git clone https://github.com/Dog-Face-Development/DFD-Code-Style-Guide.git
59+
60+
# Go into the repository
61+
$ cd DFD-Code-Style-Guide
62+
63+
# Run the webpage
64+
$ index.html
65+
```
66+
67+
You can also pull the [Docker](https://www.docker.com/) image from GitHub Packages. From your command line:
68+
69+
```bash
70+
# Pull image
71+
$ docker pull docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master
72+
73+
# Run container
74+
$ docker run -d -p 8000:80 docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master
75+
76+
# Now, navigate to localhost in your browser to see the webpage
77+
```
78+
79+
If support is required, please open a **[GitHub Discussion](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/discussions)** or join our **[Discord](https://discord.gg/73azSgcNYt)**.
80+
81+
## Contributing
82+
83+
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/compare).
84+
85+
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us (including how to sign our CLA).
86+
87+
## Credits
88+
89+
This software uses the following open source packages, projects, services or websites:
90+
91+
<!-- Credits Table -->
92+
<table>
93+
<tr>
94+
<th align="center"><img src="https://applets.imgix.net/https%3A%2F%2Fassets.ifttt.com%2Fimages%2Fchannels%2F2107379463%2Ficons%2Fmonochrome_large.png?w=240&h=240&s=8a19bbc158996d098e2fb18310ba7f33" width="150" height="150" alt="GitHub"/></th>
95+
<th align="center"><img src="https://pbs.twimg.com/profile_images/1069553420854591489/stZUQMcC_400x400.jpg" width="150" height="150" alt="W3C"/></th>
96+
<th align="center"><img src="https://videos.w3schools.com/files/images/w3schools_logo_500_04AA6D.png" width="150" height="150" alt="W3Schools"/></th>
97+
<th align="center"><img src="https://assets.simpleanalytics.com/press/logo-ratio-1-1/square.svg" width="150" height="150" alt="Simple Analytics"/></th>
98+
</tr>
99+
<tr>
100+
<td align="center">GitHub</td>
101+
<td align="center">W3C</td>
102+
<td align="center">W3Schools</td>
103+
<td align="center">Simple Analytics</td>
104+
</tr>
105+
<tr>
106+
<td align="center"><a href="https://github.com/">Web</a> - <a href="https://github.com/pricing">Plans</a></td>
107+
<td align="center"><a href="https://www.w3.org">Web</a> - <a href="https://www.w3.org/support/">Donate</a></td>
108+
<td align="center"><a href="https://www.w3schools.com">Web</a> - <a href="https://www.w3schools.com/pro/index.php">Pro</a></td>
109+
<td align="center"><a href="https://simpleanalytics.com/?referral=willtheorangeguy">Web</a> - <a href="https://www.simpleanalytics.com/pricing">Plans</a></td>
110+
</table>
111+
112+
## Contributors
113+
114+
- [@willtheorangeguy](https://github.com/willtheorangeguy) - Sponsor on [PayPal](https://paypal.me/wvdg44?country.x=CA&locale.x=en_US)
115+
116+
## You may also like...
117+
118+
- [ProgramVer](https://github.com/Dog-Face-Development/ProgramVer) - An open-source, Python GUI version window to show copyright info and licenses.
119+
- [PyWorkout](https://github.com/Dog-Face-Development/PyWorkout) - A minimal CLI to keep you inspired during your workout!
120+
- [PyAvatar](https://github.com/Dog-Face-Development/PyAvatar) - Easily display all of your creative avatars to keep them consistent across websites.
121+
122+
## License
123+
124+
This project is licensed under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/) - see the [`LICENSE`](LICENSE.md) file for details. See the [Privacy Policy](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/PRIVACY.md), [Terms and Conditions](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/TERMS.md), and [EULA](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/master/docs/legal/EULA.md) for legal information.

SECURITY.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ The following versions of the Style Guides are currently supported:
1616

1717
Please open an [issue](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues/new/choose) to report a security vulnerability. Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
1818

19-
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
20-
* Full paths of source file(s) related to the manifestation of the issue
21-
* The location of the affected source code (tag/branch/commit or direct URL)
22-
* Any special configuration required to reproduce the issue
23-
* Step-by-step instructions to reproduce the issue
24-
* Proof-of-concept or exploit code (if possible)
25-
* Impact of the issue, including how an attacker might exploit the issue
26-
* This information will help us triage your report more quickly.
19+
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
20+
- Full paths of source file(s) related to the manifestation of the issue
21+
- The location of the affected source code (tag/branch/commit or direct URL)
22+
- Any special configuration required to reproduce the issue
23+
- Step-by-step instructions to reproduce the issue
24+
- Proof-of-concept or exploit code (if possible)
25+
- Impact of the issue, including how an attacker might exploit the issue
26+
- This information will help us triage your report more quickly.
2727

2828
Contributions should follow the [`CODE_OF_CONDUCT`](CODE_OF_CONDUCT.md) and [`CONTRIBUTING`](CONTRIBUTING.md) documents.

0 commit comments

Comments
 (0)