Skip to content

Commit f68fa8d

Browse files
Add ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md
1 parent a569248 commit f68fa8d

File tree

3 files changed

+36
-2
lines changed

3 files changed

+36
-2
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
### Expected behavior
2+
_[what you expected to happen]_
3+
4+
### Actual behavior
5+
_[what actually happened]_
6+
7+
### Steps to reproduce
8+
9+
1. ...
10+
2. ...
11+
12+
### If possible, minimal yet complete reproducer code (or URL to code)
13+
14+
_[anything to help us reproducing the issue]_
15+
16+
### SwiftMetrics version/commit hash
17+
18+
_[the SwiftMetrics tag/commit hash]_
19+
20+
### Swift & OS version (output of `swift --version && uname -a`)

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
_[One line description of your change]_
2+
3+
### Motivation:
4+
5+
_[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_
6+
7+
### Modifications:
8+
9+
_[Describe the modifications you've done.]_
10+
11+
### Result:
12+
13+
_[After your change, what will change.]_

Documentation/Contributing.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,9 @@ $> Utilities/Docker/docker-utils swift-run # to run swift-run in the container
257257
7. Commit (include the Radar link or JIRA issue id in the commit message if possible and a description your changes). Try to have only 1 commit in your PR (but, of course, if you add changes that can be helpful to be kept aside from the previous commit, make a new commit for them).
258258
8. Push the commit / branch to your fork
259259
9. Make a PR from your fork / branch to `apple: main`
260-
10. Reviewers are going to be automatically added to your PR
261-
11. Merge pull request when you received approval from the reviewers (one or more)
260+
10. While creating your PR, make sure to add one of the [PR Templates](https://github.com/apple/swift-package-manager/tree/main/.github) in your PR message depending on the reasoning of your PR.
261+
11. Reviewers are going to be automatically added to your PR
262+
12. Merge pull request when you received approval from the reviewers (one or more)
262263

263264
## Using Continuous Integration
264265
SwiftPM uses [swift-ci](https://ci.swift.org) infrastructure for its continuous integration testing. The bots can be triggered on pull-requests if you have commit access. Otherwise, ask

0 commit comments

Comments
 (0)