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: CONTRIBUTING.markdown
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,18 @@
1
+
2
+
1
3
# Contributing to the Official raywenderlich.com Swift Style Guide.
2
4
3
5
This style guide is a living document that evolves with the Swift language. It is different from others you may see, because the focus is centered on readability for print and the web. We created this style guide to keep the code in our books, tutorials, and starter kits nice and consistent — even though we have many different authors working on the books.
4
6
5
7
We appreciate and encourage contributions from the community that improve this document and hence the quality of tutorials we produce. This document outlines the process for making contributions to the guide.
8
+
9
+
**Note:** You are responsible for adding your name to the list of contributors should you desire.
10
+
6
11
## Fixing Typos
7
12
8
13
Uncontroversial, non-additive changes such as misspellings, grammar or compiler errors can be fixed by simply issuing a pull request to master. The maintainer will merge the pull request or, if it is deemed "controversial" request the contributor open an issue so that other members of the community can participate in the discussion.
9
-
## Additive Changes
14
+
15
+
## Style Changes
10
16
11
17
Authors at RayWenderlich.com are expected to follow all of the rules in this style guide unless special circumstances apply. Because of this, it is important that updates happen at predictable times. Be aware in advance that there may be a significant delay (many months) before a suggestion is ratified on the master branch.
12
18
### Step 1: Open an Issue
@@ -20,7 +26,7 @@ Wait for feedback on the issue. Even if the feedback is negative, don't close th
20
26
The maintainer will decide if a change is go or no go. This decision is not necessarily based on the feedback of the community, but will often play a role. If you believe that the maintainer is mistaken, you can appeal the decision by just asking them. At this point the maintainer will poll the RayWenderlich team leads for a final decision with RayWenderlich acting as tie breaker if required. Apologies in advance if your style suggestion isn't accepted. You are always welcome, however, to make your own style guide for your organization or community!
21
27
### Step 4: Create a Pull Request on the Update branch
22
28
23
-
Given the go ahead from the maintainer, create a pull request on the update branch in the repo. There should be one of these. If it is not clear what it is, ask the maintainer. The current update branch is `swift3.`
29
+
Given the go ahead from the maintainer, create a pull request on the update branch in the repo. There should be one of these. If it is not clear what it is, ask the maintainer. The current update branch is `update.`
24
30
### Step 5: Branch Merged
25
31
26
32
At this point your involvement is complete. The maintainer will merge your PR to the update branch.
@@ -31,6 +37,3 @@ The RayWenderlich.com team has a chance to look at the final updated document be
31
37
### Step 7: Update Branch Merged to Master
32
38
33
39
Hurray!
34
-
35
-
*Note:* You are responsible for adding your name to the list of contributors should you desire.
0 commit comments