Skip to content

Commit

Permalink
Updating common files (#2062)
Browse files Browse the repository at this point in the history
  • Loading branch information
@diehlaws
diehlaws committed Aug 5, 2020
1 parent 960f3d3 commit ad68d28
Show file tree
Hide file tree
Showing 3 changed files with 154 additions and 59 deletions.
4 changes: 4 additions & 0 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Code of Conduct
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 with any additional questions or comments.
98 changes: 86 additions & 12 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,44 +1,118 @@
# Contributing to the AWS SDK for PHP

We work hard to provide a high-quality and useful SDK for our AWS services, and
we greatly value feedback and contributions from our community. Please submit
Thank you for your interest in contributing to the AWS SDK for PHP! We work hard to
provide a high-quality and useful SDK for our AWS services, and we greatly value
feedback and contributions from our community. Whether it's a new feature,
correction, or additional documentation, we welcome your pull requests. Please submit
your [issues][] or [pull requests][pull-requests] through GitHub.

## Things to keep in mind
Jump To:

* [Bug Reports](_#Bug-Reports_)
* [Feature Requests](_#Feature-Requests_)
* [Code Contributions](_#Code-Contributions_)

## How to contribute

*Before you send us a pull request, please be sure that:*

1. You're working from the latest source on the master branch.
2. You check existing open, and recently closed, pull requests to be sure that
someone else hasn't already addressed the problem.
3. You create an issue before working on a contribution that will take a significant
amount of your time.

*Creating a Pull Request*

1. Fork the repository.
2. In your fork, make your change in a branch that's based on this repo's master branch.
3. Commit the change to your fork, using a clear and descriptive commit message.
4. Create a pull request, answering any questions in the pull request form.

For contributions that will take a significant amount of time, open a new issue 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.

## Bug Reports

Bug reports are accepted through the [Issues][] page.

Before Submitting:

* Do a search through the existing issues to make sure it has not already been reported.
If it has, comment your experience or +1 so we prioritize it.
* If possible, upgrade to the latest release of the SDK. It's possible the bug has
already been fixed in the latest version.

Writing the Bug Report:

Please ensure that your bug report has the following:

* A short, descriptive title. Ideally, other community members should be able to get a
good idea of the issue just from reading the title.
* A detailed description of the problem you're experiencing. This should include:
* Expected behavior of the SDK and the actual behavior exhibited.
* Any details of your application environment that may be relevant.
* Debug information, stack trace or logs.
* If you are able to create one, include a Minimal Working Example that reproduces the issue.
* Use Markdown to make the report easier to read; i.e. use code blocks when pasting a
code snippet.

## Feature Requests

Open an [issue][] with the following:

* A short, descriptive title. Ideally, other community members should be able to get a
good idea of the feature just from reading the title.
* A detailed description of the the proposed feature.
* Why it should be added to the SDK.
* If possible, example code to illustrate how it should work.
* Use Markdown to make the request easier to read;
* If you intend to implement this feature, indicate that you'd like to the issue to be
assigned to you.


## Code Contributions

Code contributions to the SDK are done through [Pull Requests][pull-requests]. The list below are guidelines to use when submitting pull requests. These are the
same set of guidelines that the core contributors use when submitting changes, and
we ask the same of all community contributions as well:

1. The SDK is released under the [Apache license][license]. Any code you submit
will be released under that license. For substantial contributions, we may
ask you to sign a [Contributor License Agreement (CLA)][cla].
1. We follow all of the relevant PSR recommendations from the [PHP Framework
2. We follow all of the relevant PSR recommendations from the [PHP Framework
Interop Group][php-fig]. Please submit code that follows these standards.
The [PHP CS Fixer][cs-fixer] tool can be helpful for formatting your code.
1. We maintain a high percentage of code coverage in our unit tests. If you make
3. We maintain a high percentage of code coverage in our unit tests. If you make
changes to the code, please add, update, and/or remove tests as appropriate.
1. Static code analysis with [PHPStan][phpstan] is automatically run on the `src`
4. Static code analysis with [PHPStan][phpstan] is automatically run on the `src`
directory for submitted pull requests. If there is a case that needs to be
ignored by static analysis, please update the `ignoreErrors` section in the
`phpstan.neon` config file in your PR, and point out why this case warrants
ignoring.
1. We may choose not to accept pull requests that change files in the `src/data`
5. We may choose not to accept pull requests that change files in the `src/data`
directory, since we generate these files based on our internal knowledge of
the AWS services. Please check in with us ahead of time if you find a mistake
or missing feature that would affect those files.
1. If your code does not conform to the PSR standards, does not include adequate
6. If your code does not conform to the PSR standards, does not include adequate
tests, or does not contain a changelog document, we may ask you to update
your pull requests before we accept them. We also reserve the right to deny
any pull requests that do not align with our standards or goals.
1. If you would like to implement support for a significant feature that is not
7. If you would like to implement support for a significant feature that is not
yet available in the SDK, please talk to us beforehand to avoid any
duplication of effort.
1. We greatly appreciate contributions to our User Guide. The docs are written
8. We greatly appreciate contributions to our User Guide. The docs are written
as a [Sphinx][] website formatted with [reStructuredText][] (very similar to
Markdown). The User Guide is located in another repository. Please go to the
[awsdocs/aws-php-developers-guide](https://github.com/awsdocs/aws-php-developers-guide/).
repository to suggest edits for the User Guide.
1. If you are working on the SDK, make sure to check out the `Makefile` for some
9. If you are working on the SDK, make sure to check out the `Makefile` for some
of the common tasks that we have to do.

## Changelog Documents
### Changelog Documents

A changelog document is a small JSON blob placed in the `.changes/nextrelease`
folder. It should be named a clearly and uniquely, akin to a branch name. It
Expand Down
111 changes: 64 additions & 47 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,51 +13,14 @@ using services like Amazon S3, Amazon DynamoDB, Amazon Glacier, etc. You can
get started in minutes by [installing the SDK through Composer][docs-installation]
or by downloading a single zip or phar file from our [latest release][latest-release].

## Resources

* [User Guide][docs-guide] – For both getting started and in-depth SDK usage information
* [API Docs][docs-api] – For details about operations, parameters, and responses
* [Blog][sdk-blog] – Tips & tricks, articles, and announcements
* [Sample Project][sdk-sample] - A quick, sample project to help get you started
* [Forum][sdk-forum] – Ask questions, get help, and give feedback
* [Issues][sdk-issues] – Report issues, submit pull requests, and get involved
(see [Apache 2.0 License][sdk-license])
* [@awsforphp][sdk-twitter] – Follow us on Twitter

## Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

* Ask a question on [StackOverflow](https://stackoverflow.com/) and tag it with [`aws-php-sdk`](http://stackoverflow.com/questions/tagged/aws-php-sdk)
* Come join the AWS SDK for PHP [gitter](https://gitter.im/aws/aws-sdk-php)
* Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home/)
* If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-php/issues/new)

## Opening Issues

If you encounter a bug with `aws-sdk-php` we would like to hear about it. Search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of `aws-sdk-php`, PHP version and OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.

The GitHub issues are intended for bug reports and feature requests. For help and questions with using `aws-sdk-php` please make use of the resources listed in the Getting Help section. There are limited resources available for handling issues and by keeping the list of open issues lean we can respond in a timely manner.

## Features

* Provides easy-to-use HTTP clients for all supported AWS
[services][docs-services], [regions][docs-rande], and authentication
protocols.
* Is built on [Guzzle][guzzle-docs], and utilizes many of its features,
including persistent connections, asynchronous requests, middlewares, etc.
* Provides convenience features including easy result pagination via
[Paginators][docs-paginators], [Waiters][docs-waiters], and simple
[Result objects][docs-results].
* Provides a [multipart uploader tool][docs-s3-multipart] for Amazon S3 and
Amazon Glacier that can be paused and resumed.
* Provides an [Amazon S3 Stream Wrapper][docs-streamwrapper], so that you can
use PHP's native file handling functions to interact with your S3 buckets and
objects like a local filesystem.
* Provides the [Amazon DynamoDB Session Handler][docs-ddbsh] for easily scaling
sessions on a fast, NoSQL database.
* Automatically uses [IAM Instance Profile Credentials][aws-iam-credentials] on
configured Amazon EC2 instances.
Jump To:
* [Getting Started](_#Getting-Started_)
* [Quick Examples](_#Quick-Examples_)
* [Getting Help](_#Getting-Help_)
* [Features](_#Features_)
* [Contributing](_#Contributing_)
* [More Resources](_#Resources_)
* [Related AWS Projects](_#Related-AWS-Projects_)

## Getting Started

Expand Down Expand Up @@ -117,15 +80,69 @@ try {
}
```

### Related AWS Projects
## Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

* Ask a question on [StackOverflow](https://stackoverflow.com/) and tag it with [`aws-php-sdk`](http://stackoverflow.com/questions/tagged/aws-php-sdk)
* Come join the AWS SDK for PHP [gitter](https://gitter.im/aws/aws-sdk-php)
* Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home/)
* If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-php/issues/new/choose)

This SDK implements AWS service APIs. For general issues regarding the AWS services and their limitations, you may also take a look at the [Amazon Web Services Discussion Forums](https://forums.aws.amazon.com/).


### Opening Issues

If you encounter a bug with `aws-sdk-php` we would like to hear about it. Search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of `aws-sdk-php`, PHP version and OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.

The GitHub issues are intended for bug reports and feature requests. For help and questions with using `aws-sdk-php` please make use of the resources listed in the Getting Help section. There are limited resources available for handling issues and by keeping the list of open issues lean we can respond in a timely manner.

## Features

* Provides easy-to-use HTTP clients for all supported AWS
[services][docs-services], [regions][docs-rande], and authentication
protocols.
* Is built on [Guzzle][guzzle-docs], and utilizes many of its features,
including persistent connections, asynchronous requests, middlewares, etc.
* Provides convenience features including easy result pagination via
[Paginators][docs-paginators], [Waiters][docs-waiters], and simple
[Result objects][docs-results].
* Provides a [multipart uploader tool][docs-s3-multipart] for Amazon S3 and
Amazon Glacier that can be paused and resumed.
* Provides an [Amazon S3 Stream Wrapper][docs-streamwrapper], so that you can
use PHP's native file handling functions to interact with your S3 buckets and
objects like a local filesystem.
* Provides the [Amazon DynamoDB Session Handler][docs-ddbsh] for easily scaling
sessions on a fast, NoSQL database.
* Automatically uses [IAM Instance Profile Credentials][aws-iam-credentials] on
configured Amazon EC2 instances.

## Contributing

We work hard to provide a high-quality and useful SDK for our AWS services, and we greatly value feedback and contributions from our community. Please review our [contributing guidelines](./CONTRIBUTING.md) before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.


## Resources

* [User Guide][docs-guide] – For both getting started and in-depth SDK usage information
* [API Docs][docs-api] – For details about operations, parameters, and responses
* [Blog][sdk-blog] – Tips & tricks, articles, and announcements
* [Sample Project][sdk-sample] - A quick, sample project to help get you started
* [Forum][sdk-forum] – Ask questions, get help, and give feedback
* [Issues][sdk-issues] – Report issues, submit pull requests, and get involved
(see [Apache 2.0 License][sdk-license])
* [@awsforphp][sdk-twitter] – Follow us on Twitter

## Related AWS Projects

* [AWS Service Provider for Laravel][mod-laravel]
* [AWS SDK ZF2 Module][mod-zf2]
* [AWS Service Provider for Silex][mod-silex]
* [AWS SDK Bundle for Symfony][mod-symfony]
* [Amazon SNS Message Validator for PHP][sns-validator] - SNS validator without requiring SDK
* [Guzzle Version 6][guzzle-docs] – PHP HTTP client and framework
* For Version 2 of the SDK:
* For Version 2 of the SDK (deprecated):
* [User Guide][docs-guide-v2]
* [API Docs][docs-api-v2]
* Other [AWS SDKs & Tools][aws-tools] (e.g., js, cli, ruby, python, java, etc.)
Expand Down

0 comments on commit ad68d28

Please sign in to comment.