Skip to content

Commit 74d62ec

Browse files
committed
Add SwiftPM proposal template
This adds a new proposal template for SwiftPM proposals. The existing Swift proposal template is renamed to 0000-swift-template.md and both templates are moved into a directory called `proposal-templates/`.
1 parent d06d9ac commit 74d62ec

File tree

3 files changed

+63
-1
lines changed

3 files changed

+63
-1
lines changed

process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Swift, please consider how your proposal fits in with the larger goals
5252
of the upcoming Swift release. Proposals that are clearly out of scope
5353
for the upcoming Swift release will not be brought up for review. If you can't resist discussing a proposal that you know is out of scope, please include the tag `[Out of scope]` in the subject.
5454
* **Socialize the idea**: propose a rough sketch of the idea in the ["pitches" section of the Swift forums](https://forums.swift.org/c/evolution/pitches), the problems it solves, what the solution looks like, etc., to gauge interest from the community.
55-
* **Develop the proposal**: expand the rough sketch into a complete proposal, using the [proposal template](0000-template.md), and continue to refine the proposal on the forums. Prototyping an implementation and its uses along with the proposal is *required* because it helps ensure both technical feasibility of the proposal as well as validating that the proposal solves the problems it is meant to solve.
55+
* **Develop the proposal**: expand the rough sketch into a complete proposal, using the [proposal template](proposal-templates/0000-swift-template.md), and continue to refine the proposal on the forums. Prototyping an implementation and its uses along with the proposal is *required* because it helps ensure both technical feasibility of the proposal as well as validating that the proposal solves the problems it is meant to solve.
5656
* **Request a review**: initiate a pull request to the [swift-evolution repository][swift-evolution-repo] to indicate to the core team that you would like the proposal to be reviewed. When the proposal is sufficiently detailed and clear, and addresses feedback from earlier discussions of the idea, the pull request will be accepted. The proposal will be assigned a proposal number as well as a core team member to manage the review.
5757
* **Address feedback**: in general, and especially [during the review period][proposal-status], be responsive to questions and feedback about the proposal.
5858

File renamed without changes.
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Package Manager Feature name
2+
3+
* Proposal: [SE-NNNN](NNNN-filename.md)
4+
* Authors: [Author 1](https://github.com/swiftdev), [Author 2](https://github.com/swiftdev)
5+
* Review Manager: TBD
6+
* Status: **Awaiting implementation**
7+
8+
*During the review process, add the following fields as needed:*
9+
10+
* Implementation: [apple/swift-package-manager#NNNNN](https://github.com/apple/swift-package-manager/pull/NNNNN)
11+
* Decision Notes: [Rationale](https://forums.swift.org/), [Additional Commentary](https://forums.swift.org/)
12+
* Bugs: [SR-NNNN](https://bugs.swift.org/browse/SR-NNNN), [SR-MMMM](https://bugs.swift.org/browse/SR-MMMM)
13+
* Previous Revision: [1](https://github.com/apple/swift-evolution/blob/...commit-ID.../proposals/NNNN-filename.md)
14+
* Previous Proposal: [SE-XXXX](XXXX-filename.md)
15+
16+
## Introduction
17+
18+
A short description of what the feature is. Try to keep it to a single-paragraph
19+
"elevator pitch" so the reader understands what problem this proposal is
20+
addressing.
21+
22+
Swift-evolution thread: [Discussion thread topic for that
23+
proposal](https://forums.swift.org/)
24+
25+
## Motivation
26+
27+
Describe the problems that this proposal seeks to address. If the problem is
28+
that some functionality is currently hard to use, show how it is currently used
29+
and describe its drawbacks. If it's completely new functionality that cannot be
30+
emulated, motivate why this new functionality would help Swift developers create
31+
better Swift packages.
32+
33+
## Proposed solution
34+
35+
Describe your solution to the problem. Provide examples and describe how they
36+
work. Show how your solution is better than current workarounds: is it cleaner,
37+
easier, or more efficient?
38+
39+
## Detailed design
40+
41+
Describe the design of the solution in detail. If it involves adding or
42+
modifying functionality in the package manager, explain how the package manager
43+
behaves in different scenarios and with existing features. If it's a new API in
44+
the `Package.swift` manifest, show the full API and its documentation comments
45+
detailing what it does. The detail in this section should be sufficient for
46+
someone who is *not* one of the author of the proposal to be able to reasonably
47+
implement the feature.
48+
49+
## Security
50+
51+
Does this change have any impact on security, safety, or privacy?
52+
53+
## Impact on exisiting packages
54+
55+
Explain if and how this proposal will affect the behavior of existing packages.
56+
If there will be impact, is it possible to gate the changes on the tools version
57+
of the package manifest?
58+
59+
## Alternatives considered
60+
61+
Describe alternative approaches to addressing the same problem, and
62+
why you chose this approach instead.

0 commit comments

Comments
 (0)