mirror of
https://github.com/apple/swift-atomics
synced 2026-11-22 04:20:39 +00:00
Add PR and issue templates
This commit is contained in:
1 parent
83ae389117
commit
d8a2baf4d5
5 files changed
+124
No files matched your search
Executable
+40
@@ -0,0 +1,40 @@
|
||||
---
|
||||
name: 🐛 Bug Report
|
||||
about: Something isn't working as expected
|
||||
labels: bug
|
||||
---
|
||||
|
||||
<!--
|
||||
Thanks for contributing to Swift Atomics!
|
||||
|
||||
Before you submit your issue, please replace each paragraph
|
||||
below with the relevant details for your bug, and complete
|
||||
the steps in the checklist by placing an 'x' in each box:
|
||||
|
||||
- [x] I've completed this task
|
||||
- [ ] This task isn't completed
|
||||
-->
|
||||
|
||||
Replace this paragraph with a short description of the incorrect behavior.
|
||||
(If this is a regression, please note the last version of the package that exhibited the correct behavior in addition to your current version.)
|
||||
|
||||
### Information
|
||||
|
||||
- **Package version:** What tag or branch of swift-atomics are you using?
|
||||
- **Platform version:** Please tell us the version number of your operating system.
|
||||
- **Swift version:** Paste the output of `swift --version` here.
|
||||
|
||||
### Checklist
|
||||
|
||||
- [ ] If possible, I've reproduced the issue using the `main` branch of this package.
|
||||
- [ ] I've searched for [existing reports](https://github.com/apple/swift-atomics/issues) of the same issue.
|
||||
|
||||
### Steps to Reproduce
|
||||
Replace this paragraph with an explanation of how to reproduce the incorrect behavior.
|
||||
Include a simple code example, if possible.
|
||||
|
||||
### Expected behavior
|
||||
Describe what you expect to happen.
|
||||
|
||||
### Actual behavior
|
||||
Describe or copy/paste the behavior you observe.
|
||||
Executable
+13
@@ -0,0 +1,13 @@
|
||||
---
|
||||
name: 💡 Feature Request
|
||||
about: A suggestion for a new feature
|
||||
labels: enhancement
|
||||
---
|
||||
|
||||
<!-- Thanks for contributing to Swift Atomics! -->
|
||||
|
||||
<!-- Before you submit your issue, please replace this comment with a
|
||||
description of your proposed feature. Please be sure to describe some
|
||||
concrete use cases for the new feature -- be as specific as possible.
|
||||
Provide links to existing issues or external references/discussions,
|
||||
if appropriate. -->
|
||||
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: ❓ Discussion Forum
|
||||
url: https://forums.swift.org/c/related-projects/swift-atomics/
|
||||
about: Questions about using Swift Atomics? Ask here!
|
||||
@@ -0,0 +1,22 @@
|
||||
<!-- Thanks for contributing to Swift Atomics! -->
|
||||
|
||||
<!-- If this pull request adds new API, please add '?template=new.md'
|
||||
to the URL to switch to the appropriate template. -->
|
||||
|
||||
<!-- Please add a description of your changes and rationale. Provide
|
||||
links to an existing issue or external references/discussions, if
|
||||
appropriate. -->
|
||||
|
||||
<!-- Complete the steps in the checklist by placing an 'x' in each box:
|
||||
- [x] I've completed this task
|
||||
- [ ] This task isn't completed
|
||||
-->
|
||||
|
||||
|
||||
### Checklist
|
||||
- [ ] I've read the [Contribution Guidelines](/README.md#contributing-to-swift-atomics)
|
||||
- [ ] My contributions are licensed under the [Swift license](/LICENSE.txt).
|
||||
- [ ] I've followed the coding style of the rest of the project.
|
||||
- [ ] I've added tests covering all new code paths my change adds to the project (if appropriate).
|
||||
- [ ] I've verified that my change does not break any existing tests.
|
||||
- [ ] I've updated the documentation if necessary.
|
||||
@@ -0,0 +1,44 @@
|
||||
<!--
|
||||
Thanks for contributing to Swift Atomics!
|
||||
|
||||
Before you submit your request, please replace each paragraph
|
||||
below with the relevant details, and complete the steps in the
|
||||
checklist by placing an 'x' in each box:
|
||||
|
||||
- [x] I've completed this task
|
||||
- [ ] This task isn't completed
|
||||
-->
|
||||
|
||||
### Description
|
||||
Replace this paragraph with a description of your changes and rationale.
|
||||
Provide links to an existing issue or external references/discussions, if appropriate.
|
||||
|
||||
### Detailed Design
|
||||
Include any additional information about the design here. At minimum, describe a synopsis of any public API additions.
|
||||
|
||||
```swift
|
||||
/// The new feature implemented by this pull request.
|
||||
public struct Example: AtomicValue {
|
||||
}
|
||||
```
|
||||
|
||||
### Documentation
|
||||
How has the new feature been documented?
|
||||
Have the relevant portions of the guides in the Documentation folder been updated in addition to symbol-level documentation?
|
||||
|
||||
### Testing
|
||||
How is the new feature tested?
|
||||
|
||||
### Performance
|
||||
How did you verify the new feature performs as expected?
|
||||
|
||||
### Source Impact
|
||||
What is the impact of this change on existing users of this package? Does it deprecate or remove any existing API?
|
||||
|
||||
### Checklist
|
||||
- [ ] I've read the [Contribution Guidelines](/README.md#contributing-to-swift-atomics)
|
||||
- [ ] My contributions are licensed under the [Swift license](https://swift.org/LICENSE.txt).
|
||||
- [ ] I've followed the coding style of the rest of the project.
|
||||
- [ ] I've added tests covering all new code paths my change adds to the project (to the extent possible).
|
||||
- [ ] I've verified that my change does not break any existing tests.
|
||||
- [ ] I've updated the documentation (if appropriate).
|
||||
Reference in new issue
Block a user