Skip to content

Commit acc4419

Browse files
author
Sebastien Stormacq
committed
adjust to standard AWS processes
1 parent 74e4efd commit acc4419

File tree

9 files changed

+217
-204
lines changed

9 files changed

+217
-204
lines changed
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "(short issue description)"
5+
labels: [bug, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the bug
12+
description: What is the problem? A clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Expected Behavior
19+
description: |
20+
What did you expect to happen?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: current
25+
attributes:
26+
label: Current Behavior
27+
description: |
28+
What actually happened?
29+
30+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
If service responses are relevant, please include wire logs.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: reproduction
36+
attributes:
37+
label: Reproduction Steps
38+
description: |
39+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
40+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
41+
42+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: solution
48+
attributes:
49+
label: Possible Solution
50+
description: |
51+
Suggest a fix/reason for the bug
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: context
56+
attributes:
57+
label: Additional Information/Context
58+
description: |
59+
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
60+
validations:
61+
required: false
62+
63+
- type: input
64+
id: swift-sdk-version
65+
attributes:
66+
label: AWS SWIFT SDK version used
67+
validations:
68+
required: true
69+
70+
- type: input
71+
id: compiler-version
72+
attributes:
73+
label: Compiler and Version used
74+
description: Xcode version, Swift compiler version, Swift Tools version
75+
validations:
76+
required: true
77+
78+
- type: input
79+
id: operating-system
80+
attributes:
81+
label: Operating System and version
82+
validations:
83+
required: true
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "📕 Documentation Issue"
3+
description: Report an issue in the API Reference documentation or Developer Guide
4+
title: "(short issue description)"
5+
labels: [documentation, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the issue
12+
description: A clear and concise description of the issue.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: links
18+
attributes:
19+
label: Links
20+
description: |
21+
Include links to affected documentation page(s).
22+
validations:
23+
required: true
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "(short issue description)"
5+
labels: [feature-request, needs-triage]
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
## Community Note
12+
1. Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
13+
2. Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
14+
3. If you are interested in working on this issue, please leave a comment
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Describe the feature
19+
description: A clear and concise description of the feature you are proposing.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: use-case
24+
attributes:
25+
label: Use Case
26+
description: |
27+
Why do you need this feature? For example: "I'm always frustrated when..."
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: solution
32+
attributes:
33+
label: Proposed Solution
34+
description: |
35+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
36+
validations:
37+
required: false
38+
- type: textarea
39+
id: other
40+
attributes:
41+
label: Other Information
42+
description: |
43+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
44+
validations:
45+
required: false
46+
- type: checkboxes
47+
id: ack
48+
attributes:
49+
label: Acknowledgements
50+
options:
51+
- label: I may be able to implement this feature request
52+
required: false
53+
- label: This feature might incur a breaking change
54+
required: false

.github/ISSUE_TEMPLATE/issue-report.yml

Lines changed: 0 additions & 71 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1-
_[One line description of your change]_
1+
<!--- Provide a general summary of your changes in the Title above -->
22

3-
### Motivation:
3+
## Issue \#
4+
<!--- If it fixes an issue, please link to the issue here -->
45

5-
_[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_
6+
## Description of changes
7+
<!--- Why is this change required? What problem does it solve? -->
68

7-
### Modifications:
9+
## New/existing dependencies impact assessment, if applicable
10+
<!--- No new dependencies were added to this change. -->
11+
<!--- If any dependency was added / modified / removed, THIRD-PARTY-LICENSES must be updated accordingly. -->
812

9-
_[Describe the modifications you've done.]_
13+
## Conventional Commits
14+
<!--- Please use conventional commits to let us know what kind of change this is.-->
15+
<!--- More info can be found here: https://www.conventionalcommits.org/en/v1.0.0/-->
1016

11-
### Result:
12-
13-
_[After your change, what will change.]_
17+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 36 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,57 @@
1-
## Legal
1+
# Contributing Guidelines
22

3-
By submitting a pull request, you represent that you have the right to license
4-
your contribution to Apple and the community, and agree by submitting the patch
5-
that your contributions are licensed under the Apache 2.0 license (see
6-
`LICENSE.txt`).
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4+
documentation, we greatly value feedback and contributions from our community.
75

6+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7+
information to effectively respond to your bug report or contribution.
88

9-
## How to submit a bug report
109

11-
Please ensure to specify the following:
10+
## Reporting Bugs/Feature Requests
1211

13-
* SwiftAWSLambdaRuntime commit hash
14-
* Contextual information (e.g. what you were trying to achieve with SwiftAWSLambdaRuntime)
15-
* Simplest possible steps to reproduce
16-
* More complex the steps are, lower the priority will be.
17-
* A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
18-
* Anything that might be relevant in your opinion, such as:
19-
* Swift version or the output of `swift --version`
20-
* OS version and the output of `uname -a`
21-
* Network configuration
12+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
2213

14+
When filing an issue, please check [existing open](https://github.com/aws-amplify/aws-sdk-swift/issues), or [recently closed](https://github.com/aws-amplify/aws-sdk-swift/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
15+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
2316

24-
### Example
17+
* A reproducible test case or series of steps
18+
* The version of our code being used
19+
* Any modifications you've made relevant to the bug
20+
* Anything unusual about your environment or deployment
2521

26-
```
27-
SwiftAWSLambdaRuntime commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
2822

29-
Context:
30-
While load testing my Lambda written with SwiftAWSLambdaRuntime, I noticed
31-
that one file descriptor is leaked per request.
23+
## Contributing via Pull Requests
24+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
3225

33-
Steps to reproduce:
34-
1. ...
35-
2. ...
36-
3. ...
37-
4. ...
26+
1. You are working against the latest source on the *main* branch.
27+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
3829

39-
$ swift --version
40-
Swift version 4.0.2 (swift-4.0.2-RELEASE)
41-
Target: x86_64-unknown-linux-gnu
30+
To send us a pull request, please:
4231

43-
Operating system: Ubuntu Linux 16.04 64-bit
32+
1. Fork the repository.
33+
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34+
3. Ensure local tests pass.
35+
4. Commit to your fork using clear commit messages.
36+
5. Send us a pull request, answering any default questions in the pull request interface.
37+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
4438

45-
$ uname -a
46-
Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
39+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4741

48-
My system has IPv6 disabled.
49-
```
5042

51-
## Writing a Patch
43+
## Finding contributions to work on
44+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws-amplify/aws-sdk-swift/labels/help%20wanted) issues is a great place to start.
5245

53-
A good SwiftAWSLambdaRuntime patch is:
5446

55-
1. Concise, and contains as few changes as needed to achieve the end result.
56-
2. Tested, ensuring that any tests provided failed before the patch and pass after it.
57-
3. Documented, adding API documentation as needed to cover new functions and properties.
58-
4. Accompanied by a great commit message, using our commit message template.
47+
## Code of Conduct
48+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50+
opensource-codeofconduct@amazon.com with any additional questions or comments.
5951

60-
### Commit Message Template
6152

62-
We require that your commit messages match our template. The easiest way to do that is to get git to help you by explicitly using the template. To do that, `cd` to the root of our repository and run:
53+
## Licensing
6354

64-
git config commit.template dev/git.commit.template
55+
See the [LICENSE](https://github.com/aws-amplify/aws-sdk-swift/blob/main/LICENSE) file for our project's licensing. We will ask you confirm the licensing of your contribution.
6556

66-
## How to contribute your work
67-
68-
Please open a pull request at https://github.com/swift-server/swift-aws-lambda-runtime. Make sure the CI passes, and then wait for code review.
57+
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

0 commit comments

Comments
 (0)