You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/Contributing.md
+21-64Lines changed: 21 additions & 64 deletions
Original file line number
Diff line number
Diff line change
@@ -1,50 +1,37 @@
1
-
# Swift Package Manager: Quick Start
2
-
Swift Package Manager (SwiftPM) is a tool for building, testing and managing Swift project dependencies.
3
-
In order to use it you will need Swift 3.0 or greater.
4
-
SwiftPM is also included in Xcode 8.0 and above.
5
-
For usage getting started: [https://swift.org/getting-started/#using-the-package-manager](https://swift.org/getting-started/#using-the-package-manager)
6
-
For overview and examples: [https://swift.org/package-manager](https://swift.org/package-manager/)
7
-
8
1
## Code Contributions
9
-
Everyone is welcome to contribute to SwiftPM, submitting fixes, enhancement etc.
10
-
Find out how previous coding decisions for SwiftPM evolution have been made: https://github.com/apple/swift-package-manager/blob/main/Documentation/Internals/PackageManagerCommunityProposal.md
2
+
There are several types of contributions one can make. Bug fixes, documentation and enhancements that do not materially change the user facing semantics of Swift Package Manager should be submitted directly as PR.
3
+
4
+
Larger changes that do materially change the semantics of Swift Package Manager (e.g. changes to the manifest format or behavior) are required to go through [Swift Evolution Process](https://github.com/apple/swift-evolution/blob/master/process.md).
5
+
To see how previous evolution decisions for SwiftPM have been made check out https://github.com/apple/swift-package-manager/blob/main/Documentation/Internals/PackageManagerCommunityProposal.md.
6
+
7
+
For more information about making contributions to the Swift project in general see [Swift Contribution Guide](https://swift.org/contributing/)
8
+
9
+
### Ways to contribute
10
+
Report a bug guide: https://github.com/apple/swift-package-manager/blob/main/Documentation/Resources.md#reporting-a-good-swiftpm-bug.
11
+
JIRA Bug Tracker (a place where you can open bugs, enhancements to start to contribute): [https://bugs.swift.org/browse/SR-13640?jql=component%20%3D%20%22Package%20Manager%22](https://bugs.swift.org/browse/SR-13640?jql=component%20%3D%20%22Package%20Manager%22).
11
12
12
13
### Requirements
13
-
You have multiple ways to setup your development environment, here we will focus on 2:
14
-
A) *[Using Xcode](#using-xcode)* or B) [Using *the standalone Swift toolchain*](#using-standalone).
14
+
You have multiple ways to setup your development environment, here we will focus on two:
15
+
*[Using Xcode](#using-xcode)
16
+
*[Using a standalone Swift toolchain](#using-standalone).
15
17
16
18
<aid="using-xcode">*A) _Use Xcode to setup what you need_*.</a>
If the build process ends with exit code 0, the build is successful (we have an Enhancement Radar to implement a message for successful build and a short output on where the generated binaries are: rdar://69970428).
60
-
After a successful build (currently), you should see something like this:
61
-
```
62
-
[476/476] Linking swift-package
63
-
```
46
+
Make sure the build did not fail.
47
+
64
48
A `.build/` folder will be generated and it should have inside a similar structure (including build binaries):
65
49
```
66
50
artifacts/
@@ -82,23 +66,6 @@ If you need to build the generated binaries, run `swift-build` in inside `.build
82
66
If you are contributing using macOS, the best option is to use Xcode to build and run test SwiftPM.
83
67
84
68
### Troubleshooting
85
-
* If during `swift build` you encounter these outputs:
86
-
```
87
-
/../swift-package-manager/Sources/SPMTestSupport/misc.swift:93:35: warning: parameter 'file' with default argument '#file' passed to parameter 'file', whose default argument is '#filePath'
88
-
XCTFail("\(error)", file: file, line: line)
89
-
^
90
-
/../swift-package-manager/Sources/SPMTestSupport/misc.swift:37:26: note: did you mean for parameter 'file' to default to '#filePath'?
91
-
file: StaticString = #file,
92
-
^~~~~
93
-
#filePath
94
-
/../swift-package-manager/Sources/SPMTestSupport/misc.swift:93:35: note: add parentheses to silence this warning
95
-
XCTFail("\(error)", file: file, line: line)
96
-
^
97
-
( )
98
-
```
99
-
Do not worry, since those are known warnings that will be addressed at some point.
100
-
Warnings differ depending on the platform and they can be seen from time to time due the amount of contributions.
101
-
Our goal is to constantly monitor warnings and work on fix them (even if they are not affecting a successful implementation).
102
69
* If during `swift build` you encounter this error:
Report a bug guide: https://github.com/apple/swift-package-manager/blob/main/Documentation/Resources.md#reporting-a-good-swiftpm-bug.
128
-
JIRA Bug Tracker (a place where you can open bugs, enhancements to start to contribute): [https://bugs.swift.org/browse/SR-13640?jql=component%20%3D%20%22Package%20Manager%22](https://bugs.swift.org/browse/SR-13640?jql=component%20%3D%20%22Package%20Manager%22).
0 commit comments