Skip to content

Commit 0976dce

Browse files
connor-ricksconnor-ricks
committed
🎉 Initial commit
0 parents  commit 0976dce

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+3905
-0
lines changed

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto

‎.github/workflows/swiftlint.yaml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# MIT License
2+
#
3+
# Copyright (c) 2024 Connor Ricks
4+
#
5+
# Permission is hereby granted, free of charge, to any person obtaining a copy
6+
# of this software and associated documentation files (the "Software"), to deal
7+
# in the Software without restriction, including without limitation the rights
8+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
# copies of the Software, and to permit persons to whom the Software is
10+
# furnished to do so, subject to the following conditions:
11+
#
12+
# The above copyright notice and this permission notice shall be included in all
13+
# copies or substantial portions of the Software.
14+
#
15+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
# SOFTWARE.
22+
23+
name: '📚 SwiftLint'
24+
25+
on:
26+
pull_request:
27+
branches:
28+
- main
29+
paths:
30+
- '**.swift'
31+
32+
concurrency:
33+
group: ${{ github.workflow }}-${{ github.ref }}
34+
cancel-in-progress: true
35+
36+
jobs:
37+
lint:
38+
name: 📚 SwiftLint
39+
runs-on: ubuntu-latest
40+
41+
steps:
42+
# Checkout source
43+
- name: 🗄️ Checkout Code
44+
uses: actions/checkout@v4
45+
46+
# Lint
47+
- name: 📚 Linting
48+
uses: stanfordbdhg/action-swiftlint@v4
49+
with:
50+
args: --strict

‎.github/workflows/test.yaml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# MIT License
2+
#
3+
# Copyright (c) 2024 Connor Ricks
4+
#
5+
# Permission is hereby granted, free of charge, to any person obtaining a copy
6+
# of this software and associated documentation files (the "Software"), to deal
7+
# in the Software without restriction, including without limitation the rights
8+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
# copies of the Software, and to permit persons to whom the Software is
10+
# furnished to do so, subject to the following conditions:
11+
#
12+
# The above copyright notice and this permission notice shall be included in all
13+
# copies or substantial portions of the Software.
14+
#
15+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
# SOFTWARE.
22+
23+
name: '🧪 Tests'
24+
25+
on:
26+
pull_request:
27+
branches:
28+
- main
29+
30+
concurrency:
31+
group: ${{ github.workflow }}-${{ github.ref }}
32+
cancel-in-progress: true
33+
34+
jobs:
35+
test:
36+
name: 🧪 Tests
37+
runs-on: ubuntu-latest
38+
39+
steps:
40+
# Checkout source
41+
- name: 🗄️ Checkout Code
42+
uses: actions/checkout@v4
43+
44+
# Install Swiftly
45+
- name: 🪺 Install Swiftly
46+
run: curl -L https://swiftlang.github.io/swiftly/swiftly-install.sh | bash -s -- --disable-confirmation
47+
48+
# Install Swift 6
49+
- name: 🐦 Install Swift 6
50+
run: swiftly install 6.0-snapshot
51+
52+
# Run Tests
53+
- name: 🧪 Run tests
54+
run: make test

‎.gitignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.DS_Store
2+
.build
3+
.swiftpm
4+
.env
5+
xcuserdata/
6+
DerivedData/
7+
Package.resolved
8+
9+
10+
.pre-commit-unstaged-patch

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
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,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
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
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Contributing to `swift-vapor-route-builder`
2+
3+
First off, thanks for taking the time to contribute! ❤️
4+
5+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
6+
7+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
8+
> - Star the project
9+
> - Tweet about it
10+
> - Refer this project in your project's README
11+
> - Mention the project at local meetups and tell your friends/colleagues
12+
13+
## Table of Contents
14+
15+
- [I Have a Question](#i-have-a-question)
16+
- [I Want To Contribute](#i-want-to-contribute)
17+
- [Reporting Bugs](#reporting-bugs)
18+
- [Suggesting Enhancements](#suggesting-enhancements)
19+
- [Your First Code Contribution](#your-first-code-contribution)
20+
- [Improving The Documentation](#improving-the-documentation)
21+
- [Styleguides](#styleguides)
22+
- [Commit Messages](#commit-messages)
23+
- [Join The Project Team](#join-the-project-team)
24+
25+
## I Have a Question
26+
27+
> If you want to ask a question, we assume that you have read the available documentation.
28+
29+
Before you ask a question, it is best to search for existing [Issues](https://github.com/connor-ricks/swift-vapor-route-builder/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
30+
31+
If you then still feel the need to ask a question and need clarification, we recommend the following:
32+
33+
- Open an [Issue](https://github.com/connor-ricks/swift-vapor-route-builder/issues/new).
34+
- Provide as much context as you can about what you're running into.
35+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
36+
37+
We will then take care of the issue as soon as possible.
38+
39+
## I Want To Contribute
40+
41+
> ### Legal Notice
42+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
43+
44+
### Reporting Bugs
45+
46+
#### Before Submitting a Bug Report
47+
48+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
49+
50+
- Make sure that you are using the latest version.
51+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check [this section](#i-have-a-question)).
52+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [issues](https://github.com/connor-ricks/swift-vapor-route-builder/issues).
53+
- Collect information about the bug:
54+
- Stack trace (Traceback)
55+
- OS, Platform and Version (iOS, macOS, tvOS, visionOS, watchOS)
56+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
57+
- Possibly your input and the output
58+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
59+
60+
#### How Do I Submit a Good Bug Report?
61+
62+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to `[email protected]`.
63+
64+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
65+
66+
- Open an [Issue](https://github.com/connor-ricks/swift-vapor-route-builder/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
67+
- Explain the behaviour you would expect and the actual behaviour.
68+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
69+
- Provide the information you collected in the previous section.
70+
71+
### Suggesting Enhancements
72+
73+
This section guides you through submitting an enhancement suggestion for swift-vapor-route-builder, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
74+
75+
#### Before Submitting an Enhancement
76+
77+
- Make sure that you are using the latest version.
78+
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
79+
- Perform a [search](https://github.com/connor-ricks/swift-vapor-route-builder/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
80+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
81+
82+
#### How Do I Submit a Good Enhancement Suggestion?
83+
84+
Enhancement suggestions are tracked as [issues](https://github.com/connor-ricks/swift-vapor-route-builder/issues).
85+
86+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
87+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
88+
- **Describe the current behaviour** and **explain which behaviour you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
89+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
90+
- **Explain why this enhancement would be useful** to most swift-vapor-route-builder users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
91+
92+
## Styleguides
93+
### Commit Messages
94+
95+
All commits in this repo should have an associated emoji. This can be useful to quickly scan the git history for commits of relevance.
96+
97+
To have emojis automatically inserted into your commits when you type a keyword, run the following command within the repo's folder.
98+
99+
```
100+
./Utilities/setup.sh
101+
```
102+
103+
This will setup a git hook that will parse keywords between `:` into emojis when you make a commit.
104+
105+
For example, comitting
106+
107+
```
108+
:initial: :feature: Created a new nibble!
109+
```
110+
111+
Will result in the git hook converting the commit message to
112+
113+
```
114+
🎉 ✨ Created a new nibble!
115+
```
116+
117+
Below is a list of supported keywords, along with their associated usages and emojis
118+
119+
| Emoji | Keyword | Usage |
120+
|-------|-------------------|------------------------------------------------|
121+
| 🐛 | bug | Indicates a bug fix. |
122+
| 🧹 | cleanup | Indicates a small cleanup of code. |
123+
| 📦 | dependency | Indicates the addition of a dependency. |
124+
| 📚 | docs | Indicates documentation updates. |
125+
| ✨ | feauture | Indicates a new feature. |
126+
| 🛠 | fixup | Indicates a quick tweak of code. |
127+
| 🎉 | initial | Indicates an initial commit of a project. |
128+
| 🏎 | performance | Indicates improvements to performance. |
129+
| ♻️ | refactor | Indicates code refactoring. |
130+
| 🗑️ | removal | Indicates the removal of code. |
131+
| 🔒 | security | Indicates a security fix. |
132+
| 🎨 | styling | Indicates changes to code styling. |
133+
| 🔖 | tag | Indicates a tag for a version. |
134+
| 🧪 | tests | Indicates test related work. |
135+
| 🧰 | tooling | Indicates changes to tooling (Such as Actions) |
136+
| 🚧 | wip | Indicates work that is in-progress. |
137+
138+
139+
## Attribution
140+
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

0 commit comments

Comments
 (0)