Skip to content

Commit a7127c2

Browse files
authored
Merge branch 'master' into master
2 parents cf3bd41 + 2a45dd9 commit a7127c2

File tree

390 files changed

+22273
-13736
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

390 files changed

+22273
-13736
lines changed

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Guidelines for contributing
2+
3+
Thank you for your interest in contributing to AWS documentation! We greatly value feedback and contributions from our community.
4+
5+
Please read through this document before you submit any pull requests or issues. It will help us work together more effectively.
6+
7+
## What to expect when you contribute
8+
9+
When you submit a pull request, our team is notified and will respond as quickly as we can. We'll do our best to work with you to ensure that your pull request adheres to our style and standards. If we merge your pull request, we might make additional edits later for style or clarity.
10+
11+
The AWS documentation source files on GitHub aren't published directly to the official documentation website. If we merge your pull request, we'll publish your changes to the documentation website as soon as we can, but they won't appear immediately or automatically.
12+
13+
We look forward to receiving your pull requests for:
14+
15+
* New content you'd like to contribute (such as new code samples or tutorials)
16+
* Inaccuracies in the content
17+
* Information gaps in the content that need more detail to be complete
18+
* Typos or grammatical errors
19+
* Suggested rewrites that improve clarity and reduce confusion
20+
21+
**Note:** We all write differently, and you might not like how we've written or organized something currently. We want that feedback. But please be sure that your request for a rewrite is supported by the previous criteria. If it isn't, we might decline to merge it.
22+
23+
## How to contribute
24+
25+
To contribute, send us a pull request. For small changes, such as fixing a typo or adding a link, you can use the [GitHub Edit Button](https://blog.github.com/2011-04-26-forking-with-the-edit-button/). For larger changes:
26+
27+
1. [Fork the repository](https://help.github.com/articles/fork-a-repo/).
28+
2. In your fork, make your change in a branch that's based on this repo's **master** branch.
29+
3. Commit the change to your fork, using a clear and descriptive commit message.
30+
4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/), answering any questions in the pull request form.
31+
32+
Before you send us a pull request, please be sure that:
33+
34+
1. You're working from the latest source on the **master** branch.
35+
2. You check [existing open](https://github.com/awsdocs/aws-lambda-developer-guide/pulls), and [recently closed](https://github.com/awsdocs/aws-lambda-developer-guide/pulls?q=is%3Apr+is%3Aclosed), pull requests to be sure that someone else hasn't already addressed the problem.
36+
3. You [create an issue](https://github.com/awsdocs/aws-lambda-developer-guide/issues/new) before working on a contribution that will take a significant amount of your time.
37+
38+
For contributions that will take a significant amount of time, [open a new issue](https://github.com/awsdocs/aws-lambda-developer-guide/issues/new) to pitch your idea before you get started. Explain the problem and describe the content you want to see added to the documentation. Let us know if you'll write it yourself or if you'd like us to help. We'll discuss your proposal with you and let you know whether we're likely to accept it. We don't want you to spend a lot of time on a contribution that might be outside the scope of the documentation or that's already in the works.
39+
40+
## Finding contributions to work on
41+
42+
If you'd like to contribute, but don't have a project in mind, look at the [open issues](https://github.com/awsdocs/aws-lambda-developer-guide/issues) in this repository for some ideas. Any issues with the [help wanted](https://github.com/awsdocs/aws-lambda-developer-guide/labels/help%20wanted) or [enhancement](https://github.com/awsdocs/aws-lambda-developer-guide/labels/enhancement) labels are a great place to start.
43+
44+
In addition to written content, we really appreciate new examples and code samples for our documentation, such as examples for different platforms or environments, and code samples in additional languages.
45+
46+
## Code of conduct
47+
48+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). For more information, see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments.
49+
50+
## Security issue notifications
51+
52+
If you discover a potential security issue, please notify AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public issue on GitHub.
53+
54+
## Licensing
55+
56+
See the [LICENSE](https://github.com/awsdocs/aws-lambda-developer-guide/blob/master/LICENSE) file for this project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
Lambda User Guide and API operations and how it integrates with other AWS Service
44

5+
Start with documentaion [index](/doc_source/index.md)
6+
57
## License Summary
68

7-
The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.
9+
The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the [LICENSE](./LICENSE) file.
810

9-
The sample code within this documentation is made available under a modified MIT license. See the LICENSE-SAMPLECODE file.
11+
The sample code within this documentation is made available under a modified MIT license. See the [LICENSE-SAMPLECODE](./LICENSE-SAMPLECODE) file.

0 commit comments

Comments
 (0)