Skip to content

Commit 727f098

Browse files
0xTimmportiz08
andauthored
Remove references to JIRA in the docs (#659)
* Update README.md to remove JIRA references * Update CONTRIBUTING.md to remove JIRA references --------- Co-authored-by: Marcus Ortiz <[email protected]>
1 parent 50a8807 commit 727f098

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ from the community.
3535
### Contributing Code and Documentation
3636

3737
Before contributing code or documentation to Swift-DocC-Render
38-
we encourage you to first create an issue on [Swift JIRA](https://bugs.swift.org/)
38+
we encourage you to first create an issue on [GitHub](https://github.com/apple/swift-docc-render/issues/new/choose)
3939
for a bug report or feature request.
4040
This will allow us to provide feedback on the proposed change.
4141
However, this is not a requirement. If your contribution is small in scope,
@@ -125,8 +125,8 @@ When you're ready to have your change reviewed, please make sure you've complete
125125
When opening a pull request, please make sure to fill out the pull request template
126126
and complete all tasks mentioned there.
127127

128-
Your PR should mention the number of the [Swift JIRA](https://bugs.swift.org/)
129-
issue your work is addressing (SR-NNNNN).
128+
Your PR should mention the number of the [GitHub issue](https://github.com/apple/swift-docc-render/issues)
129+
issue your work is addressing (#NNN).
130130

131131
Most PRs should be against the `main` branch. If your change is intended
132132
for a specific release, you should also create a separate branch
@@ -184,8 +184,8 @@ npm run lint:fix
184184
## Your First Contribution
185185

186186
Unsure of where to begin contributing to Swift-DocC-Render? You can start by looking at
187-
the bugs in the `Swift-DocC-Render` component with the `StarterBug` label on
188-
[Swift JIRA](https://bugs.swift.org/issues/?jql=project%20%3D%20SR%20AND%20status%20in%20(Open%2C%20Reopened)%20AND%20component%20%3D%20Swift-DocC-Render%20AND%20labels%20%3D%20StarterBug).
187+
the bugs in the `Swift-DocC-Render` issues list with the `StarterBug` label on
188+
[GitHub](https://github.com/apple/swift-docc-render/issues?q=is%3Aissue+is%3Aopen+label%3AStarterBug).
189189

190190
Once you've found an issue to work on,
191191
follow the above instructions for [Building Swift-DocC-Render](#build-and-run-swift-docc-render).

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To build the docs, run `npm run docs:build`.
5151
5252
### Submitting a Bug Report
5353
54-
Swift-DocC-Render tracks all bug reports with [Swift JIRA](https://bugs.swift.org/).
54+
Swift-DocC-Render tracks all bug reports with [GitHub](https://github.com/apple/swift-docc-render/issues).
5555
When you submit a bug report we ask that you follow the
5656
Swift [Bug Reporting](https://swift.org/contributing/#reporting-bugs) guidelines
5757
and provide as many details as possible.
@@ -63,7 +63,7 @@ that will help us track down the bug faster.
6363
### Submitting a Feature Request
6464
6565
For feature requests, please feel free to create an issue
66-
on [Swift JIRA](https://bugs.swift.org/) with the `New Feature` type
66+
on [GitHub](https://github.com/apple/swift-docc-render/issues/new?assignees=&labels=New+Feature&projects=&template=FEATURE_REQUEST.yml) with the `New Feature` type
6767
or start a discussion on the [Swift Forums](https://forums.swift.org/c/development/swift-docc).
6868
6969
Don't hesitate to submit a feature request if you see a way

0 commit comments

Comments
 (0)