Skip to content

Commit 4f313b9

Browse files
committed
1 parent 03f7fcb commit 4f313b9

File tree

382 files changed

+57
-46148
lines changed

Some content is hidden

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

382 files changed

+57
-46148
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,64 @@
1-
# Guidelines for contributing
1+
# Contributing Guidelines
22

3-
Thank you for your interest in contributing to AWS documentation! We greatly value feedback and contributions from our community.
3+
Thank you for your interest in contributing to our project. We greatly value feedback and contributions from our community.
44

5-
Please read through this document before you submit any pull requests or issues. It will help us work together more effectively.
5+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
6+
information to effectively respond to your bug report or contribution.
67

7-
## What to expect when you contribute
88

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.
9+
## Reporting Bugs/Feature Requests
1010

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.
11+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1212

13-
We look forward to receiving your pull requests for:
13+
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
14+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1415

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
16+
* A reproducible test case or series of steps
17+
* The version of our code being used
18+
* Any modifications you've made relevant to the bug
19+
* Anything unusual about your environment or deployment
2020

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.
2221

23-
## How to contribute
22+
## Contributing via Pull Requests
2423

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:
24+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
2625

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 **main** 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.
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.
3129

32-
Before you send us a pull request, please be sure that:
30+
To send us a pull request, please:
3331

34-
1. You're working from the latest source on the **main** 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.
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.
38+
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/).
3741

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.
3942

4043
## Finding contributions to work on
4144

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.
45+
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.
46+
4347

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.
48+
## Code of Conduct
4549

46-
## Code of conduct
50+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
51+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
52+
opensource-codeofconduct@amazon.com with any additional questions or comments.
4753

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.
4954

5055
## Security issue notifications
5156

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.
57+
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.
58+
5359

5460
## Licensing
5561

56-
See the [LICENSE](https://github.com/awsdocs/aws-lambda-developer-guide/blob/main/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.
62+
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
63+
64+
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)