Skip to content

Commit ceec2f3

Browse files
SomeRandomiOSDevSomeRandomiOSDev
committed
Bulk updates
Regenerated project using the latest from ProjectTemplate. Added DocC documentation and fixed up/added code documentation where needed. Added pull request and issue form templates. Added code of conduct, contributing, and contributors documents. Updated all workflows to run using `macOS-11` and added filters to avoid unnecessary workflow runs. Added log artifacts to relevant workflows. Added and updated scripts. Fixed up Codacy issues.
1 parent 5d1226a commit ceec2f3

File tree

68 files changed

+3098
-565
lines changed

Some content is hidden

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

68 files changed

+3098
-565
lines changed

‎.github/CODE_OF_CONDUCT.md‎

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

‎.github/CONTRIBUTING.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Before getting started
2+
3+
I just want to say a special thanks for looking to improve this project. I truly love the open source community and it wouldn't be what it is today without people like you.
4+
5+
# How to contribute
6+
7+
There are three main ways in which you contribute:
8+
9+
1. Open a [Bug Report](https://github.com/SomeRandomiOSDev/CBORCoding/issues/new?assignees=SomeRandomiOSDev&labels=bug&template=BUG_REPORT.yml&title=%5BBUG%5D%3A+).
10+
2. Open a [Feature Request](https://github.com/SomeRandomiOSDev/CBORCoding/issues/new?assignees=SomeRandomiOSDev&labels=enhancement&template=FEATURE_REQUEST.yml&title=%5BFEATURE%5D%3A+).
11+
3. Create a [Pull Request](https://github.com/SomeRandomiOSDev/CBORCoding/compare).
12+
13+
> If none of these really suit your needs, you could also open a [blank issue](https://github.com/SomeRandomiOSDev/CBORCoding/issues/new).
14+
15+
If you need further guidance or have additional questions, you can always reach out at
16+
17+
* somerandomiosdev@gmail.com
18+
19+
Please also note we have a [code of conduct](#code-of-conduct), please follow it in all your interactions with the project.
20+
21+
## Getting started
22+
23+
For contributing via *Bug Reports* or *Feature Requests* contribuing is as simple as opening that specific issue.
24+
25+
> We use GitHub issue forms for submitting these types of issues. For reference, those form templates can be found [here](ISSUE_TEMPLATE/BUG_REPORT.yml) for Bug Reports and [here](ISSUE_TEMPLATE/FEATURE_REQUEST.yml) for Feature Requests.
26+
27+
For contributing via *Pull Requests*, we ask the following of you prior to opening a `pull request` to help maintain code standards and quality (many of these are enforced with workflows, but who wants to push subsequent commits for a single PR?):
28+
29+
* Please try and follow the implicit code conventions and naming schemes present within the project.
30+
* All Swift files for this project lint successfully. The latest version of SwiftLint should be used for linting.
31+
* The builds for all platforms should succeed, along with all of the unit tests for each platform.
32+
* Any new code added should be accompanied by appropriate unit test code to cover (virtually) all cases and paths through that code. The code coverage for this project shouldn't decrease by a significant amount, but increases in code coverage are always welcome and appreciated.
33+
* Any new public APIs added should be accompanied by documentation in code, and as appropriate, in the [README](../README.md) file and in the Documentation Catalog.
34+
* Since this project is available via [CocoaPods](https://cocoapods.org), it should lint successfully for both `pod lib lint` and `pod lib lint --use-libraries` using the latest version of the `pod` utility.
35+
36+
> Tip: It's strongly recommended to use the [workflowtests.sh](../scripts/workflowtests.sh) script for testing all of the various builds & linting as this script is a mirror of the workflows that are ran for `pull requests`.
37+
38+
For further guidance about requirements for `pull requests`, please see the [Pull Request Guidelines](PULL_REQUEST_TEMPLATE.md) document.
39+
40+
## Code of Conduct
41+
42+
As far as it pertains to contributions to this project, we do not and will not discriminate against people on any grouds aside from those contributions. Furthermore, discrimination from other persons will not be tolerated in any capacity.
43+
44+
We may, at our own discretion, remove, block from commenting/contributing, or otherwise persons who violate these guideline or those laid out below in order to maintain and inclusive productive community.
45+
46+
For the full text of these guidelines, please read the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) document.

‎.github/CONTRIBUTORS.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributors
2+
3+
## Special thanks for all the people who have contributed this project so far
4+
5+
I would like to give a special thanks to all of the people below who have contributed to this project and to all of those who will contribute to it moving forward.
6+
7+
- [Jos Kuijpers](https://github.com/joskuijpers)
8+
9+
## I would like to join this list! How can I help the project?
10+
11+
We appreciate your enthusiam and would love to have your contribution! We are constantly looking for ways to improve this project and often suffer from (code) writers block, sometimes stagnating progress. That's where you come in! Whether you're reporting bugs, suggesting features, or writing code yourself, we want it!
12+
13+
For more information on how to contribute (and have your name show up here), please refer to our [CONTRIBUTING](CONTRIBUTING.md) guide.

‎.github/ISSUE_TEMPLATE/BUG_REPORT.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Bug Report
2+
description: Create a report to help us improve this project!
3+
title: "[BUG]: "
4+
labels: ["bug"]
5+
assignees:
6+
- SomeRandomiOSDev
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: "Thanks for taking the time to fill out this bug report!"
12+
13+
- type: textarea
14+
id: expected-behavior
15+
attributes:
16+
label: "Expected Behavior"
17+
description: "A clear and concise description of what you expected to happen."
18+
placeholder: "What was supposed to happen?"
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: actual-behavior
24+
attributes:
25+
label: "Actual Behavior"
26+
description: "A clear and concise description of what actually happened."
27+
placeholder: "What actually happened?"
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: steps
33+
attributes:
34+
label: "Steps To Reproduce"
35+
placeholder: |
36+
1. Do this...
37+
2. Do that...
38+
...
39+
validations:
40+
required: true
41+
42+
- type: input
43+
id: project-version
44+
attributes:
45+
label: "Project Version"
46+
description: "The version of the project where this issue occurred."
47+
placeholder: "0.1.5, a7df908, username/issue-branch, ..."
48+
validations:
49+
required: true
50+
51+
- type: checkboxes
52+
id: os
53+
attributes:
54+
label: "The OS/Variant where this issue occurs."
55+
description: "If \"Other\" is selected, please provide the additional OS in the \"Additional Context\" section."
56+
options:
57+
- label: "iOS"
58+
- label: "macOS"
59+
- label: "tvOS"
60+
- label: "watchOS"
61+
- label: "Mac Catalyst"
62+
- label: "Other (Please specify in \"Additional Context\" section)"
63+
validations:
64+
required: true
65+
66+
- type: input
67+
id: xcode-version
68+
attributes:
69+
label: "The version of Xcode that was used when this issue appeared."
70+
placeholder: "12.1.1, 13.0 Beta 4, Build 13A1030d, ..."
71+
validations:
72+
required: true
73+
74+
- type: checkboxes
75+
id: environment
76+
attributes:
77+
label: "What was the environment in which the issue appeared?"
78+
options:
79+
- label: "CBORCoding.xcodeproj"
80+
- label: "Package.swift"
81+
- label: "Carthage"
82+
- label: "CocoaPods"
83+
- label: "Swift Package Manager"
84+
- label: "Other (Please specify in \"Additional Context\" section)"
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: additional-context
90+
attributes:
91+
label: "Additional Context"
92+
description: |
93+
Add any other context about the problem (e.g. screenshots, links, logs, references, sample projects, etc.)
94+
95+
Tip: You can attach files here by clicking this area to highlight it and then dragging files in.
96+
validations:
97+
required: false

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature Request
2+
description: Suggest your awesome idea for this project!
3+
title: "[FEATURE]: "
4+
labels: ["enhancement"]
5+
assignees:
6+
- SomeRandomiOSDev
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: "Thanks for taking the time to fill out this feature request!"
12+
13+
- type: textarea
14+
id: existing-problem
15+
attributes:
16+
label: "Is your feature request related to a problem?"
17+
description: "A clear and concise description of what the problem is."
18+
placeholder: "e.g. I'm already frustrated when [...]"
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: "Describe the solution you'd like."
26+
placeholder: "e.g It would be a lot better if [...]"
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: alternatives
32+
attributes:
33+
label: "Describe alternatives you've considered."
34+
validations:
35+
required: false
36+
37+
- type: input
38+
id: current-progress
39+
attributes:
40+
label: "Have you already worked out some solution or have a PoC?"
41+
description: "Please provide the repo where we can find your work."
42+
placeholder: "e.g. username/partial-solution"
43+
validations:
44+
required: false
45+
46+
- type: textarea
47+
id: additional-context
48+
attributes:
49+
label: "Additional Context"
50+
description: |
51+
Add any other context about the feature request here (e.g. screenshots, links, references, sample projects, etc.)
52+
53+
Tip: You can attach files here by clicking this area to highlight it and then dragging files in.
54+
validations:
55+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Pull Request Process
2+
3+
## Before submitting a pull request
4+
5+
Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository and remove this and all lines above this one prior to submitting your `pull request`.
6+
7+
## Description
8+
9+
A brief description of your `pull request`.
10+
11+
## Checklist
12+
13+
Ensure that your `pull request` has followed all the steps below:
14+
15+
* [ ] Code compilation.
16+
* [ ] All tests passing.
17+
* [ ] No new SwiftLint issues.
18+
* [ ] Added new unit tests, if applicable.
19+
* [ ] Extended the documentation (including README), if applicable.
20+
* [ ] Updated version in CBORCoding.podspec following [semver](https://semver.org) guidelines.
21+
* [ ] Ran [workflowtests.sh](../../scripts/workflowtests.sh) and passed.
22+
* [ ] Added myself to the [CONTRIBUTORS](../CONTRIBUTORS.md) file.
23+
24+
## Proposed changes
25+
26+
A detailed explaination of your changes and why these should be added to this project.
27+
28+
If this is related to one or more [issues](https://github.com/SomeRandomiOSDev/CBORCoding/issues), please add `closes #XXXX` (or any other [acceptable notation](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)) to link this pull request to them.
29+
30+
## Additional Info
31+
32+
Any other relevant information that needs to be known about this `pull request` (e.g. "tvOS 14.0 and up", "Requires Xcode 13", etc.).

0 commit comments

Comments
 (0)