Skip to content

Commit 3324b98

Browse files
committed
slight re-org and cleaning up MD lint warnings
1 parent 85ee4c1 commit 3324b98

File tree

1 file changed

+30
-27
lines changed

1 file changed

+30
-27
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Contributions to Swift are welcomed and encouraged!
44
For contributions to the broader Swift Language project, please see the
55
[Contributing to Swift guide](https://swift.org/contributing/).
66

7-
To give clarity of what is expected of our members, Swift has adopted the code of conduct defined by the Contributor Covenant.
8-
This document is used across many open source communities, and we think it articulates our values well.
9-
For more detail, see the [Code of Conduct](https://swift.org/code-of-conduct/).
7+
To give clarity of what is expected of our members, Swift has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/).
8+
This document is used across many open source communities, and it articulates our values.
9+
For more detail, read the project's [Code of Conduct](https://swift.org/code-of-conduct/).
1010

1111
It is highly recommended that you become familiar with using Swift in your own projects before contributing directly to the language itself.
1212
We put together handy [Getting Started](https://www.swift.org/getting-started/) guide and tutorials with step-by-step instructions to get you up and running.
@@ -34,13 +34,6 @@ Include information about the Swift compiler’s version, the deployment target
3434
Because Swift is under very active development, we receive a lot of bug reports.
3535
Before opening a new issue, take a moment to [browse our existing issues](https://github.com/swiftlang/swift/issues) to reduce the chance of reporting a duplicate.
3636

37-
## Proposing changes - Swift Evolution
38-
39-
Shaping the future of Swift is a community effort that anyone can participate in via the [Evolution sections on the Swift forums](https://www.swift.org/community/#swift-evolution).
40-
The [Swift evolution process](https://github.com/swiftlang/swift-evolution/blob/main/process.md) covers all changes to the Swift language and the public interface of the Swift standard library, including new language features and APIs, changes to existing language features or APIs, removal of existing features, and so on.
41-
42-
See the [Swift evolution review schedule](https://www.swift.org/swift-evolution) for current and upcoming proposal reviews.
43-
4437
## Good First Issues
4538

4639
Good first issues are bugs, ideas, and tasks that are intended to be accessible for contributors that are new to working on the Swift project, and even new to the patterns and concepts behind subprojects such as the Swift compiler.
@@ -53,6 +46,7 @@ Anyone with [commit access](https://www.swift.org/contributing/#commit-access) a
5346
## Contributing Code
5447

5548
If you are interested in:
49+
5650
- Contributing fixes and features to the compiler: See our
5751
[How to Submit Your First Pull Request guide](/docs/HowToGuides/FirstPullRequest.md).
5852
- Building the compiler as a one-off: See our [Getting Started guide][].
@@ -64,6 +58,13 @@ We also host answers to [Frequently Aasked Questions](/docs/HowToGuides/FAQ.md)
6458

6559
[Getting Started guide]: /docs/HowToGuides/GettingStarted.md
6660

61+
### Proposing changes - Swift Evolution
62+
63+
Shaping the future of Swift is a community effort that anyone can participate in via the [Evolution sections on the Swift forums](https://www.swift.org/community/#swift-evolution).
64+
The [Swift evolution process](https://github.com/swiftlang/swift-evolution/blob/main/process.md) covers all changes to the Swift language and the public interface of the Swift standard library, including new language features and APIs, changes to existing language features or APIs, removal of existing features, and so on.
65+
66+
See the [Swift evolution review schedule](https://www.swift.org/swift-evolution) for current and upcoming proposal reviews.
67+
6768
### Incremental Development
6869

6970
The Swift project uses small, incremental changes as its preferred development model.
@@ -176,23 +177,6 @@ The divider lines should be exactly 80 characters wide to aid in adherence to th
176177
The bottom section contains an optional description intended for generated documentation (these lines begin with `///` rather than `//`).
177178
If there is no description, this area can be skipped.
178179

179-
### Release Branch Pull Requests
180-
181-
A pull request targeting a release branch (`release/x.y` or `swift/release/x.y`) cannot be merged without a GitHub approval by a corresponding branch manager.
182-
In order for a change to be considered for inclusion in a release branch, the pull request must have:
183-
184-
A title starting with a designation containing the release version number of the target branch.
185-
186-
[This form](https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md?plain=1) filled out in its description.
187-
An item that is not applicable may be left blank or completed with an indication thereof, but must not be omitted altogether.
188-
189-
To switch to this template when drafting a pull request in a [swiftlang](https://github.com/swiftlang) repository in a browser, append the `template=release.md` query parameter to the current URL and refresh. For example:
190-
191-
-https://github.com/swiftlang/swift/compare/main...my-branch?quick_pull=1
192-
+https://github.com/swiftlang/swift/compare/main...my-branch?quick_pull=1&template=release.md
193-
194-
[Here](https://github.com/swiftlang/swift/pull/73697) is an example.
195-
196180
### Code Review
197181

198182
The Swift project relies heavily on code review to improve software quality:
@@ -257,6 +241,25 @@ You are expected to check those messages to see whether they are your fault and,
257241
Commits that clearly violate these quality standards may be reverted, in particular when the change blocks other developers from making progress.
258242
The developer is welcome to recommit the change after the problem has been fixed.
259243

244+
### Release Branch Pull Requests
245+
246+
A pull request targeting a release branch (`release/x.y` or `swift/release/x.y`) cannot be merged without a GitHub approval by a corresponding branch manager.
247+
In order for a change to be considered for inclusion in a release branch, the pull request must have:
248+
249+
A title starting with a designation containing the release version number of the target branch.
250+
251+
[This form](https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md?plain=1) filled out in its description.
252+
An item that is not applicable may be left blank or completed with an indication thereof, but must not be omitted altogether.
253+
254+
To switch to this template when drafting a pull request in a [swiftlang](https://github.com/swiftlang) repository in a browser, append the `template=release.md` query parameter to the current URL and refresh. For example:
255+
256+
```diff
257+
-https://github.com/swiftlang/swift/compare/main...my-branch?quick_pull=1
258+
+https://github.com/swiftlang/swift/compare/main...my-branch?quick_pull=1&template=release.md
259+
```
260+
261+
[Here](https://github.com/swiftlang/swift/pull/73697) is an example.
262+
260263
### Commit Access
261264

262265
Commit access is granted to contributors with a track record of submitting high-quality changes.

0 commit comments

Comments
 (0)