File tree Expand file tree Collapse file tree 5 files changed +103
-3
lines changed
Expand file tree Collapse file tree 5 files changed +103
-3
lines changed Original file line number Diff line number Diff line change 1+ name : Content Issue
2+ description : Something is missing or incorrect
3+ labels : ["Content Issue"]
4+ body :
5+ - type : markdown
6+ attributes :
7+ value : |
8+ Thank you for contributing to "The Swift Programming Language"!
9+
10+ Before you submit your issue, please provide the relevant details in the text areas below.
11+ - type : textarea
12+ attributes :
13+ label : Location
14+ description : |
15+ The URL of the content that has a problem.
16+ validations :
17+ required : false
18+ - type : textarea
19+ attributes :
20+ label : Description
21+ description : |
22+ A short description of what's wrong.
23+ validations :
24+ required : true
25+ - type : textarea
26+ attributes :
27+ label : Correction
28+ description : |
29+ What should the documentation say instead?
30+ validations :
31+ required : false
Original file line number Diff line number Diff line change 1+ name : Enhancement
2+ description : A suggestion for new content
3+ labels : [Enhancement]
4+ body :
5+ - type : markdown
6+ attributes :
7+ value : |
8+ Thank you for contributing to "The Swift Programming Language"!
9+
10+ Before you submit your issue, please provide the relevant details in the text areas below.
11+ - type : textarea
12+ attributes :
13+ label : Location
14+ description : |
15+ The URL of the chapter or section where the new content would go.
16+ validations :
17+ required : false
18+ - type : textarea
19+ attributes :
20+ label : Description
21+ description : |
22+ A short description of your proposed addition.
23+ validations :
24+ required : true
25+ - type : textarea
26+ attributes :
27+ label : Motivation
28+ description : A description of the use-case this proposed documentation will serve.
29+ validations :
30+ required : false
31+ - type : textarea
32+ attributes :
33+ label : Alternatives Considered
34+ description : If you considered alternative approaches, please include them here.
35+ validations :
36+ required : false
Original file line number Diff line number Diff line change 1+ blank_issues_enabled : yes
2+
3+ contact_links :
4+ - name : Documentation Forums Category
5+ url : https://forums.swift.org/c/92
6+ about : Ask and answer questions about writing documentation
7+ - name : Swift-DocC Forums Category
8+ url : https://forums.swift.org/c/80
9+ about : Ask and answer questions about using Swift-DocC
10+ - name : Swift-DocC Documentation
11+ url : https://www.swift.org/documentation/docc/
12+ about : Learn about how to use Swift-DocC for authoring documentation
Original file line number Diff line number Diff line change 1+ <!-- What's in this pull request? -->
2+ Replace this paragraph with your rationale and a brief summary of what changed.
3+
4+ <!-- If this pull request fixes a bug tracked in GitHub issues, provide the link. -->
5+ Fixes https://github.com/apple/swift-book/issues/####
6+
7+
8+ <!--
9+ Before merging this pull request, you must run the continuous integration (CI) tests.
10+ When you're ready to start a CI build,
11+ write the following in a comment on the pull request:
12+
13+ @swift-ci Please test.
14+
15+ For more information about triggering CI builds via @swift-ci, see:
16+
17+ https://github.com/apple/swift/blob/main/docs/ContinuousIntegration.md#swift-ci
18+
19+ Thank you for your contribution!
20+ -->
Original file line number Diff line number Diff line change @@ -34,7 +34,8 @@ and [this book’s style guide][tspl-style].
3434Use the following steps when creating a new pull request:
3535
36361 . Create a local fork of this repository with your changes.
37- 2 . Test that your changes build locally by running ` swift package plugin generate-documentation --target TSPL --transform-for-static-hosting ` .
37+ 2 . Test that your changes build locally by running ` make preview ` .
38383 . Create a pull request in this repository.
39- 4 . Add @amartini51 and @krilnon as reviewers.
40- 5 . Confirm that your changes build in CI by commenting ` @swift-ci please test ` on your pull request.
39+
40+ Within a few days,
41+ someone will assign reviewers and start a build in CI.
You can’t perform that action at this time.
0 commit comments