|
1 | | -## Legal |
| 1 | +# Contributing Guidelines |
2 | 2 |
|
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. |
7 | 5 |
|
| 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. |
8 | 8 |
|
9 | | -## How to submit a bug report |
10 | 9 |
|
11 | | -Please ensure to specify the following: |
| 10 | +## Reporting Bugs/Feature Requests |
12 | 11 |
|
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. |
22 | 13 |
|
| 14 | +When filing an issue, please check existing open, or recently closed, 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: |
23 | 16 |
|
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 |
25 | 21 |
|
26 | | -``` |
27 | | -SwiftAWSLambdaRuntime commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757 |
28 | 22 |
|
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: |
32 | 25 |
|
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. |
38 | 29 |
|
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: |
42 | 31 |
|
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. |
44 | 38 |
|
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/). |
47 | 41 |
|
48 | | -My system has IPv6 disabled. |
49 | | -``` |
50 | 42 |
|
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' issues is a great place to start. |
52 | 45 |
|
53 | | -A good SwiftAWSLambdaRuntime patch is: |
54 | 46 |
|
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. |
59 | 51 |
|
60 | | -### Commit Message Template |
61 | 52 |
|
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 | +## Security issue notifications |
| 54 | +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. |
63 | 55 |
|
64 | | - git config commit.template dev/git.commit.template |
65 | 56 |
|
66 | | -## How to contribute your work |
| 57 | +## Licensing |
67 | 58 |
|
68 | | -Please open a pull request at https://github.com/awslabs/swift-aws-lambda-events. Make sure the CI passes, and then wait for code review. |
| 59 | +See the [LICENSE](LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution. |
0 commit comments