Skip to content

Commit 5b6a258

Browse files
euanheuanh
committed
Initial commit
0 parents  commit 5b6a258

Some content is hidden

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

62 files changed

+5163
-0
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
### Description
2+
3+
_[Explain what causes the problem you're reporting.]_
4+
5+
### Reproduction
6+
7+
_[Please provide inputs to help us reproduce the problem. Try to reduce the test case to the smallest amount of code possible which still reproduces the problem.]_
8+
9+
### Package versions
10+
11+
_[Provide the version of the Swift Container Plugin you are using when encountering the problem.]_
12+
13+
### Expected behavior
14+
15+
_[Describe what you expect to happen.]_
16+
17+
### Environment
18+
19+
_[Provide the Swift version, tag, or revision you are using.]_
20+
21+
### Additional information
22+
23+
_[Provide any extra information which could help others understand or work around the problem.]_

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### Motivation
2+
3+
_[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_
4+
5+
### Modifications
6+
7+
_[Describe the modifications you've made.]_
8+
9+
### Result
10+
11+
_[After your change, what will change.]_
12+
13+
### Test Plan
14+
15+
_[Describe the steps you took, or will take, to qualify the change - such as adjusting tests and manual testing.]_

‎.github/release.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
changelog:
2+
categories:
3+
- title: SemVer Major
4+
labels:
5+
- semver/major
6+
- title: SemVer Minor
7+
labels:
8+
- semver/minor
9+
- title: SemVer Patch
10+
labels:
11+
- semver/patch
12+
- title: Other Changes
13+
labels:
14+
- semver/none
15+
- "*"

‎.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.DS_Store
2+
/.build
3+
/Packages
4+
xcuserdata/
5+
DerivedData/
6+
.swiftpm/configuration/registries.json
7+
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
8+
.netrc
9+
/Package.resolved

‎.swift-format

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"fileScopedDeclarationPrivacy" : {
3+
"accessLevel" : "private"
4+
},
5+
"indentation" : {
6+
"spaces" : 4
7+
},
8+
"indentConditionalCompilationBlocks" : false,
9+
"indentSwitchCaseLabels" : false,
10+
"lineBreakAroundMultilineExpressionChainComponents" : true,
11+
"lineBreakBeforeControlFlowKeywords" : false,
12+
"lineBreakBeforeEachArgument" : true,
13+
"lineBreakBeforeEachGenericRequirement" : true,
14+
"lineLength" : 120,
15+
"maximumBlankLines" : 1,
16+
"prioritizeKeepingFunctionOutputTogether" : false,
17+
"respectsExistingLineBreaks" : false,
18+
"rules" : {
19+
"AllPublicDeclarationsHaveDocumentation" : true,
20+
"AlwaysUseLowerCamelCase" : false,
21+
"AlwaysUseLiteralForEmptyCollectionInit" : true,
22+
"AmbiguousTrailingClosureOverload" : true,
23+
"BeginDocumentationCommentWithOneLineSummary" : false,
24+
"DoNotUseSemicolons" : true,
25+
"DontRepeatTypeInStaticProperties" : false,
26+
"FileScopedDeclarationPrivacy" : true,
27+
"FullyIndirectEnum" : true,
28+
"GroupNumericLiterals" : true,
29+
"IdentifiersMustBeASCII" : true,
30+
"NeverForceUnwrap" : false,
31+
"NeverUseForceTry" : false,
32+
"NeverUseImplicitlyUnwrappedOptionals" : false,
33+
"NoAccessLevelOnExtensionDeclaration" : false,
34+
"NoAssignmentInExpressions" : true,
35+
"NoBlockComments" : true,
36+
"NoCasesWithOnlyFallthrough" : true,
37+
"NoEmptyTrailingClosureParentheses" : true,
38+
"NoLabelsInCasePatterns" : false,
39+
"NoLeadingUnderscores" : false,
40+
"NoParensAroundConditions" : true,
41+
"NoVoidReturnOnFunctionSignature" : true,
42+
"OmitExplicitReturns" : true,
43+
"OneCasePerLine" : true,
44+
"OneVariableDeclarationPerLine" : true,
45+
"OnlyOneTrailingClosureArgument" : true,
46+
"OrderedImports" : false,
47+
"ReplaceForEachWithForLoop" : true,
48+
"ReturnVoidInsteadOfEmptyTuple" : true,
49+
"UseEarlyExits" : false,
50+
"UseLetInEveryBoundCaseVariable" : false,
51+
"UseShorthandTypeNames" : true,
52+
"UseSingleLinePropertyGetter" : false,
53+
"UseSynthesizedInitializer" : true,
54+
"UseTripleSlashForDocumentationComments" : true,
55+
"UseWhereClausesInForLoops" : false,
56+
"ValidateDocumentationComments" : true
57+
},
58+
"spacesAroundRangeFormationOperators" : false,
59+
"tabWidth" : 8,
60+
"version" : 1
61+
}

‎CODE_OF_CONDUCT.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code of Conduct
2+
3+
The code of conduct for this project can be found at https://swift.org/code-of-conduct.
4+
5+
<!-- Copyright (c) 2023 Apple Inc and the Swift Project authors. All Rights Reserved. -->

‎CONTRIBUTING.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
## Legal
2+
3+
By submitting a pull request, you represent that you have the right to license
4+
your contribution to Apple and the community, and agree by submitting the patch
5+
that your contributions are licensed under the Apache 2.0 license (see
6+
`LICENSE.txt`).
7+
8+
## How to submit a bug report
9+
10+
Please ensure to specify the following:
11+
12+
* Commit hash
13+
* Contextual information (e.g. what you were trying to achieve with swift-container-plugin)
14+
* Simplest possible steps to reproduce
15+
* More complex the steps are, lower the priority will be.
16+
* A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
17+
* Anything that might be relevant in your opinion, such as:
18+
* Swift version or the output of `swift --version`
19+
* OS version and the output of `uname -a`
20+
* Network configuration
21+
22+
### Example
23+
24+
```
25+
Commit hash: b17a8a9f0f814c01a56977680cb68d8a779c951f
26+
27+
Context:
28+
While testing my application that uses with swift-container-plugin, I noticed that ...
29+
30+
Steps to reproduce:
31+
1. ...
32+
2. ...
33+
3. ...
34+
4. ...
35+
36+
$ swift --version
37+
Swift version 4.0.2 (swift-4.0.2-RELEASE)
38+
Target: x86_64-unknown-linux-gnu
39+
40+
Operating system: Ubuntu Linux 16.04 64-bit
41+
42+
$ uname -a
43+
Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
44+
45+
My system has IPv6 disabled.
46+
```
47+
48+
## Writing a Patch
49+
50+
A good patch is:
51+
52+
1. Concise, and contains as few changes as needed to achieve the end result.
53+
2. Tested, ensuring that any tests provided failed before the patch and pass after it.
54+
3. Documented, adding API documentation as needed to cover new functions and properties.
55+
4. Accompanied by a great commit message, using our commit message template.
56+
57+
### Run `./scripts/soundness.sh`
58+
59+
The scripts directory contains a [soundness.sh script](https://github.com/apple/swift-container-plugin/blob/main/scripts/soundness.sh)
60+
that enforces additional checks, like license headers and formatting style.
61+
62+
Please make sure to `./scripts/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
63+
on minor changes such as a missing `self.` or similar formatting issues.
64+
65+
For frequent contributors, we recommend adding the script as a [git pre-push hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks), which you can do via executing the following command in the project root directory:
66+
67+
```bash
68+
cat << EOF > .git/hooks/pre-push
69+
70+
if [[ -f "scripts/soundness.sh" ]]; then
71+
scripts/soundness.sh
72+
fi
73+
EOF
74+
```
75+
76+
Which makes the script execute, and only allow the `git push` to complete if the check has passed.
77+
78+
In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again.
79+
80+
## How to contribute your work
81+
82+
Please open a pull request at https://github.com/apple/swift-container-plugin. Make sure the CI passes, and then wait for code review.

‎CONTRIBUTORS.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
For the purpose of tracking copyright, this is the list of individuals and
2+
organizations who have contributed source code to SwiftContainerPlugin.
3+
4+
For employees of an organization/company where the copyright of work done
5+
by employees of that company is held by the company itself, only the company
6+
needs to be listed here.
7+
8+
## COPYRIGHT HOLDERS
9+
10+
- Apple Inc. (all contributors with '@apple.com')
11+
12+
### Contributors
13+
14+
- Euan Harris <[email protected]>
15+
16+
**Updating this list**
17+
18+
Please do not edit this file manually. It is generated using `bash ./scripts/generate-contributors-list.sh`. If a name is misspelled or appearing multiple times: add an entry in `./.mailmap`

0 commit comments

Comments
 (0)