Skip to content

Commit d4503d3

Browse files
jaredrummlerjaredrummler
authored
Merge pull request #4 from goatbytes/develop
v1.0.1
2 parents 8275589 + 792f1eb commit d4503d3

File tree

3 files changed

+140
-34
lines changed

3 files changed

+140
-34
lines changed

‎README.md

Lines changed: 55 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,49 @@
22

33
## Introduction
44

5-
:wave: Welcome to GoatStyles, a repository for professional code style guides, where we strive to
5+
:wave: Welcome to GoatStyles, a repository for professional code style guides, where we strive to
66
uphold the highest standards of software engineering.
77

8-
In the realm of code style guides, we understand that opinions vary, and decisions often balance
9-
between necessity and subjectivity. However, amidst this diversity of perspectives, one principle
10-
remains paramount: __consistency__. By adhering to a consistent style, developers can enhance
8+
In the realm of code style guides, we understand that opinions vary, and decisions often balance
9+
between necessity and subjectivity. However, amidst this diversity of perspectives, one principle
10+
remains paramount: __consistency__. By adhering to a consistent style, developers can enhance
1111
readability, maintainability, and collaboration within their codebases.
1212

1313
## Styles
1414

1515
Click on the programming language logo to view the style guide for that language.
1616

17-
| ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ |
18-
|:-----------------------------------------------:|:------------------------------------------------------------------:|:----------------------------------------------:|:--------------------------------------:|:------------------------------------------:|:--------------------------------------------------------------:|
19-
| [![C++][CPP_Logo]][CPP]<br>**C**++ | [![C#][CSharp_Logo]][CSharp]<br>**C**# | [![Dart][Dart_Logo]][Dart]<br>**Dart** | [![Go][Go_Logo]][Go]<br>**Go** | [![Java][Java_Logo]][Java]<br>**Java** | [![JavaScript][JavaScript_Logo]][JavaScript]<br>**JavaScript** |
20-
| [![Kotlin][Kotlin_Logo]][Kotlin]<br>**Kotlin** | [![Objective-C][Objective-C_Logo]][Objective-C]<br>**Objective-C** | [![Python][Python_Logo]][Python]<br>**Python** | [![Rust][Rust_Logo]][Rust]<br>**Rust** | [![Swift][Swift_Logo]][Swift]<br>**Swift** | [![TypeScript][TypeScript_Logo]][TypeScript]<br>**TypeScript** |
17+
| ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ | ▁▁▁▁▁▁▁ |
18+
|:----------------------------------------------:|:------------------------------------------------------------------:|:----------------------------------------------:|:--------------------------------------:|:------------------------------------------:|:--------------------------------------------------------------:|
19+
| [![C++][CPP_Logo]][CPP]<br>**C**++ | [![C#][CSharp_Logo]][CSharp]<br>**C**# | [![Dart][Dart_Logo]][Dart]<br>**Dart** | [![Go][Go_Logo]][Go]<br>**Go** | [![Java][Java_Logo]][Java]<br>**Java** | [![JavaScript][JavaScript_Logo]][JavaScript]<br>**JavaScript** |
20+
| [![Kotlin][Kotlin_Logo]][Kotlin]<br>**Kotlin** | [![Objective-C][Objective-C_Logo]][Objective-C]<br>**Objective-C** | [![Python][Python_Logo]][Python]<br>**Python** | [![Rust][Rust_Logo]][Rust]<br>**Rust** | [![Swift][Swift_Logo]][Swift]<br>**Swift** | [![TypeScript][TypeScript_Logo]][TypeScript]<br>**TypeScript** |
21+
22+
## Badges
23+
24+
Enhance your project's documentation by adding our style guide badges, signaling to fellow
25+
developers the coding standards and conventions your project adheres to. Each badge links directly
26+
to a comprehensive style guide for its respective programming language.
27+
28+
[![Style Guide-C++](https://img.shields.io/badge/Style%20Guide-C++-00599C.svg?style=flat&labelColor=black&color=00599C&logo=cplusplus)](https://styles.goatbytes.io/lang/cpp)
29+
[![Style Guide-C#](https://img.shields.io/badge/Style%20Guide-C%23-178600.svg?style=flat&labelColor=black&color=178600&logo=csharp)](https://styles.goatbytes.io/lang/csharp)
30+
[![Style Guide-Dart](https://img.shields.io/badge/Style%20Guide-Dart-00B4AB.svg?style=flat&labelColor=black&color=00B4AB&logo=dart)](https://styles.goatbytes.io/lang/dart)
31+
[![Style Guide-Go](https://img.shields.io/badge/Style%20Guide-Go-00ADD8.svg?style=flat&labelColor=black&color=00ADD8&logo=go)](https://styles.goatbytes.io/lang/go)
32+
[![Style Guide-Java](https://img.shields.io/badge/Style%20Guide-Java-ED8B00.svg?style=flat&labelColor=black&color=ED8B00&logo=java)](https://styles.goatbytes.io/lang/java)
33+
[![Style Guide-JavaScript](https://img.shields.io/badge/Style%20Guide-JavaScript-F0DB4F.svg?style=flat&labelColor=black&color=F0DB4F&logo=javascript)](https://styles.goatbytes.io/lang/javascript)
34+
[![Style Guide-Kotlin](https://img.shields.io/badge/Style%20Guide-Kotlin-7F52FF.svg?style=flat&labelColor=black&color=7F52FF&logo=kotlin)](https://styles.goatbytes.io/lang/kotlin)
35+
[![Style Guide-Objective-C](https://img.shields.io/badge/Style%20Guide-Objective--C-438EFF.svg?style=flat&labelColor=black&color=438EFF)](https://styles.goatbytes.io/lang/objective-c)
36+
[![Style Guide-Python](https://img.shields.io/badge/Style%20Guide-Python-3776AB.svg?style=flat&labelColor=black&color=3776AB&logo=python)](https://styles.goatbytes.io/lang/python)
37+
[![Style Guide-Rust](https://img.shields.io/badge/Style%20Guide-Rust-DEA584.svg?style=flat&labelColor=black&color=DEA584&logo=rust)](https://styles.goatbytes.io/lang/rust)
38+
[![Style Guide-Shell](https://img.shields.io/badge/Style%20Guide-Shell-4EAA25.svg?style=flat&labelColor=black&color=4EAA25&logo=gnu-bash)](https://styles.goatbytes.io/lang/shell)
39+
[![Style Guide-Swift](https://img.shields.io/badge/Style%20Guide-Swift-FA7343.svg?style=flat&labelColor=black&color=FA7343&logo=swift)](https://styles.goatbytes.io/lang/swift)
40+
[![Style Guide-TypeScript](https://img.shields.io/badge/Style%20Guide-TypeScript-3178C6.svg?style=flat&labelColor=black&color=3178C6&logo=typescript)](https://styles.goatbytes.io/lang/typescript)
2141

2242
## Project Overview
2343

2444
### Programming Languages
2545

26-
GoatStyles provides comprehensive style guides for C++, C#, Dart, Go, Java, JavaScript, Kotlin,
27-
Objective-C, Python, Rust, Shell, Swift, and TypeScript. Our aim is to support a wide range of
46+
GoatStyles provides comprehensive style guides for C++, C#, Dart, Go, Java, JavaScript, Kotlin,
47+
Objective-C, Python, Rust, Shell, Swift, and TypeScript. Our aim is to support a wide range of
2848
development environments, catering to the diverse needs of the software development community.
2949

3050
### Technology Stack and Tools
@@ -35,17 +55,17 @@ development environments, catering to the diverse needs of the software developm
3555

3656
### Repository Structure
3757

38-
The GoatStyles style guides are meticulously documented in Markdown and located within the
39-
[`docs/styles`](docs/lang) directory of the repository.
58+
The GoatStyles style guides are meticulously documented in Markdown and located within the
59+
[`docs/lang`](docs/lang) directory of the repository.
4060

4161
## How to Contribute
4262

43-
We encourage contributions to GoatStyles! Before making a contribution, please review our
44-
[contributing](docs/contributing.md) guidelines. All contributors must complete our
63+
We encourage contributions to GoatStyles! Before making a contribution, please review our
64+
[contributing](docs/contributing.md) guidelines. All contributors must complete our
4565
[Individual Contributor License Agreement (CLA)][CLA] before their code can be accepted.
4666

47-
Forking the repository and proposing changes through pull requests are great ways to contribute.
48-
Though not all suggestions may be accepted, your contributions are highly appreciated and crucial
67+
Forking the repository and proposing changes through pull requests are great ways to contribute.
68+
Though not all suggestions may be accepted, your contributions are highly appreciated and crucial
4969
to the project's growth and diversity.
5070

5171
## Build Instructions
@@ -54,8 +74,8 @@ To build and serve the GoatStyles site locally, follow these instructions:
5474

5575
### Prerequisites
5676

57-
- **Python 3.x**: Ensure you have Python 3.x installed on your machine. You can check your
58-
Python version by running `python --version` in your terminal.
77+
- **Python 3.x**: Ensure you have Python 3.x installed on your machine. You can check your
78+
Python version by running `python --version` in your terminal.
5979
- **Git**: Make sure Git is installed for cloning the repository.
6080

6181
### Steps
@@ -68,7 +88,7 @@ Python version by running `python --version` in your terminal.
6888
```
6989

7090
2. **Set Up Python Environment (Optional)**
71-
- It's recommended to create a virtual environment to keep dependencies required by the project
91+
- It's recommended to create a virtual environment to keep dependencies required by the project
7292
separate from your global Python environment:
7393
```shell
7494
python -m venv venv
@@ -93,11 +113,11 @@ Python version by running `python --version` in your terminal.
93113
```shell
94114
mkdocs serve
95115
```
96-
- This command starts a local web server that serves the GoatStyles site. You can view the site
116+
- This command starts a local web server that serves the GoatStyles site. You can view the site
97117
by navigating to `http://127.0.0.1:8000` in your web browser.
98118
99119
6. **Making Changes**
100-
- You can now make changes to the Markdown files. The site will automatically rebuild and
120+
- You can now make changes to the Markdown files. The site will automatically rebuild and
101121
refresh the browser page when you save changes.
102122
103123
## License
@@ -106,6 +126,8 @@ Python version by running `python --version` in your terminal.
106126
107127
# `};`
108128
129+
[//]: # (@formatter:off)
130+
109131
[GS]: https://styles.goatbytes.io
110132
[GB]: https://goatbytes.io
111133
[GH]: https://github.com/goatbytes/GoatStyles
@@ -127,15 +149,15 @@ Python version by running `python --version` in your terminal.
127149
[TypeScript_Logo]: ./docs/assets/img/typescript.svg
128150
129151
<!-- Page URLs -->
130-
[CPP]: https://goatbytes.github.io/GoatStyles/styles/cpp/
131-
[CSharp]: https://goatbytes.github.io/GoatStyles/styles/csharp/
132-
[Dart]: https://goatbytes.github.io/GoatStyles/styles/dart/
133-
[Go]: https://goatbytes.github.io/GoatStyles/styles/go/
134-
[Java]: https://goatbytes.github.io/GoatStyles/styles/java/
135-
[JavaScript]: https://goatbytes.github.io/GoatStyles/styles/javascript/
136-
[Kotlin]: https://goatbytes.github.io/GoatStyles/styles/kotlin/
137-
[Objective-C]: https://goatbytes.github.io/GoatStyles/styles/objc/
138-
[Python]: https://goatbytes.github.io/GoatStyles/styles/python/
139-
[Rust]: https://goatbytes.github.io/GoatStyles/styles/rust/
140-
[Swift]: https://goatbytes.github.io/GoatStyles/styles/swift/
141-
[TypeScript]: https://goatbytes.github.io/GoatStyles/styles/typescript/
152+
[CPP]: https://styles.goatbytes.io/lang/cpp/
153+
[CSharp]: https://styles.goatbytes.io/lang/csharp/
154+
[Dart]: https://styles.goatbytes.io/lang/dart/
155+
[Go]: https://styles.goatbytes.io/lang/go/
156+
[Java]: https://styles.goatbytes.io/lang/java/
157+
[JavaScript]: https://styles.goatbytes.io/lang/javascript/
158+
[Kotlin]: https://styles.goatbytes.io/lang/kotlin/
159+
[Objective-C]: https://styles.goatbytes.io/lang/objc/
160+
[Python]: https://styles.goatbytes.io/lang/python/
161+
[Rust]: https://styles.goatbytes.io/lang/rust/
162+
[Swift]: https://styles.goatbytes.io/lang/swift/
163+
[TypeScript]: https://styles.goatbytes.io/lang/typescript/

‎docs/index.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,86 @@ address common pitfalls specific to the respective programming languages. By fol
2020
guidelines, developers can write code that is not only consistent but also optimized for readability
2121
and maintainability.
2222
///
23+
24+
## Badges
25+
26+
Enhance your project's documentation by adding our style guide badges, signaling to fellow
27+
developers the coding standards and conventions your project adheres to. Each badge links directly
28+
to a comprehensive style guide for its respective programming language.
29+
30+
**Copy Markdown Snippets for Badges**
31+
32+
/// tab | [![Style Guide-C++](https://img.shields.io/badge/Style%20Guide-C++-00599C.svg?style=flat&labelColor=black&color=00599C&logo=cplusplus)](https://styles.goatbytes.io/lang/cpp)
33+
```{.markdown .copy}
34+
[![Style Guide-C++](https://img.shields.io/badge/Style%20Guide-C++-00599C.svg?style=flat&labelColor=black&color=00599C&logo=cplusplus)](https://styles.goatbytes.io/lang/cpp)
35+
```
36+
///
37+
/// tab | [![Style Guide-C#](https://img.shields.io/badge/Style%20Guide-C%23-178600.svg?style=flat&labelColor=black&color=178600&logo=csharp)](https://styles.goatbytes.io/lang/csharp)
38+
```{.markdown .copy}
39+
[![Style Guide-C#](https://img.shields.io/badge/Style%20Guide-C%23-178600.svg?style=flat&labelColor=black&color=178600&logo=csharp)](https://styles.goatbytes.io/lang/csharp)
40+
```
41+
///
42+
/// tab | [![Style Guide-Dart](https://img.shields.io/badge/Style%20Guide-Dart-00B4AB.svg?style=flat&labelColor=black&color=00B4AB&logo=dart)](https://styles.goatbytes.io/lang/dart)
43+
```{.markdown .copy}
44+
[![Style Guide-Dart](https://img.shields.io/badge/Style%20Guide-Dart-00B4AB.svg?style=flat&labelColor=black&color=00B4AB&logo=dart)](https://styles.goatbytes.io/lang/dart)
45+
```
46+
///
47+
/// tab | [![Style Guide-Go](https://img.shields.io/badge/Style%20Guide-Go-00ADD8.svg?style=flat&labelColor=black&color=00ADD8&logo=go)](https://styles.goatbytes.io/lang/go)
48+
```{.markdown .copy}
49+
[![Style Guide-Go](https://img.shields.io/badge/Style%20Guide-Go-00ADD8.svg?style=flat&labelColor=black&color=00ADD8&logo=go)](https://styles.goatbytes.io/lang/go)
50+
```
51+
///
52+
/// tab | [![Style Guide-Java](https://img.shields.io/badge/Style%20Guide-Java-ED8B00.svg?style=flat&labelColor=black&color=ED8B00&logo=java)](https://styles.goatbytes.io/lang/java)
53+
```{.markdown .copy}
54+
[![Style Guide-Java](https://img.shields.io/badge/Style%20Guide-Java-ED8B00.svg?style=flat&labelColor=black&color=ED8B00&logo=java)](https://styles.goatbytes.io/lang/java)
55+
```
56+
///
57+
/// tab | [![Style Guide-JavaScript](https://img.shields.io/badge/Style%20Guide-JavaScript-F0DB4F.svg?style=flat&labelColor=black&color=F0DB4F&logo=javascript)](https://styles.goatbytes.io/lang/javascript)
58+
```{.markdown .copy}
59+
[![Style Guide-JavaScript](https://img.shields.io/badge/Style%20Guide-JavaScript-F0DB4F.svg?style=flat&labelColor=black&color=F0DB4F&logo=javascript)](https://styles.goatbytes.io/lang/javascript)
60+
```
61+
///
62+
/// tab | [![Style Guide-Kotlin](https://img.shields.io/badge/Style%20Guide-Kotlin-7F52FF.svg?style=flat&labelColor=black&color=7F52FF&logo=kotlin)](https://styles.goatbytes.io/lang/kotlin)
63+
```{.markdown .copy}
64+
[![Style Guide-Kotlin](https://img.shields.io/badge/Style%20Guide-Kotlin-7F52FF.svg?style=flat&labelColor=black&color=7F52FF&logo=kotlin)](https://styles.goatbytes.io/lang/kotlin)
65+
```
66+
///
67+
/// tab | [![Style Guide-Objective-C](https://img.shields.io/badge/Style%20Guide-Objective--C-438EFF.svg?style=flat&labelColor=black&color=438EFF)](https://styles.goatbytes.io/lang/objective-c)
68+
```{.markdown .copy}
69+
[![Style Guide-Objective-C](https://img.shields.io/badge/Style%20Guide-Objective--C-438EFF.svg?style=flat&labelColor=black&color=438EFF)](https://styles.goatbytes.io/lang/objective-c)
70+
```
71+
///
72+
/// tab | [![Style Guide-Python](https://img.shields.io/badge/Style%20Guide-Python-3776AB.svg?style=flat&labelColor=black&color=3776AB&logo=python)](https://styles.goatbytes.io/lang/python)
73+
```{.markdown .copy}
74+
[![Style Guide-Python](https://img.shields.io/badge/Style%20Guide-Python-3776AB.svg?style=flat&labelColor=black&color=3776AB&logo=python)](https://styles.goatbytes.io/lang/python)
75+
```
76+
///
77+
/// tab | [![Style Guide-Rust](https://img.shields.io/badge/Style%20Guide-Rust-DEA584.svg?style=flat&labelColor=black&color=DEA584&logo=rust)](https://styles.goatbytes.io/lang/rust)
78+
```{.markdown .copy}
79+
[![Style Guide-Rust](https://img.shields.io/badge/Style%20Guide-Rust-DEA584.svg?style=flat&labelColor=black&color=DEA584&logo=rust)](https://styles.goatbytes.io/lang/rust)
80+
```
81+
///
82+
/// tab | [![Style Guide-Shell](https://img.shields.io/badge/Style%20Guide-Shell-4EAA25.svg?style=flat&labelColor=black&color=4EAA25&logo=gnu-bash)](https://styles.goatbytes.io/lang/shell)
83+
```{.markdown .copy}
84+
[![Style Guide-Shell](https://img.shields.io/badge/Style%20Guide-Shell-4EAA25.svg?style=flat&labelColor=black&color=4EAA25&logo=gnu-bash)](https://styles.goatbytes.io/lang/shell)
85+
```
86+
///
87+
/// tab | [![Style Guide-Swift](https://img.shields.io/badge/Style%20Guide-Swift-FA7343.svg?style=flat&labelColor=black&color=FA7343&logo=swift)](https://styles.goatbytes.io/lang/swift)
88+
```{.markdown .copy}
89+
[![Style Guide-Swift](https://img.shields.io/badge/Style%20Guide-Swift-FA7343.svg?style=flat&labelColor=black&color=FA7343&logo=swift)](https://styles.goatbytes.io/lang/swift)
90+
```
91+
///
92+
/// tab | [![Style Guide-TypeScript](https://img.shields.io/badge/Style%20Guide-TypeScript-3178C6.svg?style=flat&labelColor=black&color=3178C6&logo=typescript)](https://styles.goatbytes.io/lang/typescript)
93+
```{.markdown .copy}
94+
[![Style Guide-TypeScript](https://img.shields.io/badge/Style%20Guide-TypeScript-3178C6.svg?style=flat&labelColor=black&color=3178C6&logo=typescript)](https://styles.goatbytes.io/lang/typescript)
95+
```
96+
///
97+
---
98+
99+
## License
100+
101+
[GoatStyles][GH] is licensed under [Attribution-ShareAlike 4.0 International][LICENSE]
102+
103+
[GB]: https://goatbytes.io
104+
[GH]: https://github.com/goatbytes/GoatStyles
105+
[LICENSE]: https://creativecommons.org/licenses/by-sa/4.0/

‎docs/lang/kotlin.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ formatting rules and conventions specified herein.
372372
6. Rename the downloaded file to `.editorconfig`.
373373
6. Add the `.editorconfig` file to your project root directory.
374374

375-
[EditorConfig File &nbsp;:fontawesome-solid-download:][JB_XML]{ .md-button .md-button--primary }
375+
[EditorConfig File &nbsp;:fontawesome-solid-download:][JB_EDITORCONFIG]{ .md-button .md-button--primary }
376376

377377
///
378378
/// tab | XML Config
@@ -409,6 +409,7 @@ remains clean and consistent with Kotlin best practices.
409409
[SonarQube]: https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/languages/kotlin/
410410
[AndroidLint]: https://developer.android.com/studio/write/lint
411411
[JB_XML]: ../assets/files/kotlin-jetbrains.xml
412+
[JB_EDITORCONFIG]: ../assets/files/kotlin.editorconfig
412413
[CodingConventions]: https://kotlinlang.org/docs/coding-conventions.html
413414
[AwesomeKotlin]: https://github.com/mcxiaoke/awesome-kotlin
414415
[AndroidKotlinGuide]: https://developer.android.com/kotlin/style-guide

0 commit comments

Comments
 (0)