Merge pull request #189 from diehlaws/common-files-standardization

Updating common files

Author: diehlaws

CODE_OF_CONDUCT.md

@@ -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 
+[email protected] with any additional questions or comments.

CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing to the AWS Service Provider for Laravel
+
+Thank you for your interest in contributing to the AWS Service Provider for Laravel! 
+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.
+
+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][issues] 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].
+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.
+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.
+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.
+5. 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.
+6. 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.
+7. 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.
+8. 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.
+
+
+[issues]: https://github.com/aws/aws-sdk-php-laravel/issues
+[pull-requests]: https://github.com/aws/aws-sdk-php-laravel/pulls
+[license]: http://aws.amazon.com/apache2.0/
+[cla]: https://github.com/aws/aws-cla/blob/master/amazon-single-contribution-license.txt
+[php-fig]: http://php-fig.org
+[cs-fixer]: http://cs.sensiolabs.org/
+[phpstan]: https://github.com/phpstan/phpstan
+[sphinx]: http://sphinx-doc.org/
+[restructuredtext]: http://sphinx-doc.org/rest.html

README.md

@@ -18,8 +18,15 @@ PHP and Laravel 5.1.
 * **2.x** ([2.0 branch](https://github.com/aws/aws-sdk-php-laravel/tree/2.0)) - For `laravel/framework:5.0.*` and `aws/aws-sdk-php:~2.4`
 * **1.x** ([1.0 branch](https://github.com/aws/aws-sdk-php-laravel/tree/1.0)) - For `laravel/framework:4.*` and `aws/aws-sdk-php:~2.4`
 
-## Installation
+Jump To:
+* [Getting Started](_#Getting-Started_)
+* [Getting Help](_#Getting-Help_)
+* [Contributing](_#Contributing_)
+* [More Resources](_#Resources_)
 
+## Getting Started
+
+### Installation
 The AWS Service Provider can be installed via [Composer](http://getcomposer.org) by requiring the
 `aws/aws-sdk-php-laravel` package in your project's `composer.json`.
 
@@ -39,14 +46,14 @@ php composer.phar update
 To use the AWS Service Provider, you must register the provider when bootstrapping your application.
 
 
-### Lumen
+#### Lumen
 In Lumen find the `Register Service Providers` in your `bootstrap/app.php` and register the AWS Service Provider.
 
 ```php
     $app->register(Aws\Laravel\AwsServiceProvider::class);
 ```
 
-### Laravel
+#### Laravel
 In Laravel find the `providers` key in your `config/app.php` and register the AWS Service Provider.
 
 ```php
@@ -65,7 +72,7 @@ Find the `aliases` key in your `config/app.php` and add the AWS facade alias.
     )
 ```
 
-## Configuration
+### Configuration
 
 By default, the package uses the following environment variables to auto-configure the plugin without modification:
 ```
@@ -100,13 +107,13 @@ return [
 
 Note that you can always delete the `credentials` line from this file if you'd like to use the [default SDK Configuration Provider chain](https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html#default-credential-chain) instead.
 
-Referring Laravel 5.2.0 [Upgrade guide](https://laravel.com/docs/5.2/upgrade#upgrade-5.2.0), you must using config

+Referring Laravel 5.2.0 [Upgrade guide](https://laravel.com/docs/5.2/upgrade#upgrade-5.2.0), you must using config
 file instead of environment variable option if using php artisan `config:cache`.
 
 Learn more about [configuring the SDK](http://docs.aws.amazon.com/aws-sdk-php/v3/guide/guide/configuration.html) on
 the SDK's User Guide.
 
-## Usage
+### Usage
 
 In order to use the AWS SDK for PHP within your app, you need to retrieve it from the [Laravel Service
 Container](https://laravel.com/docs/container#binding). The following example uses the Amazon S3 client to upload a file.
@@ -132,7 +139,28 @@ $s3->putObject(array(
 ));
 ```
 
-## Links
+## 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-laravel/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-laravel` 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-laravel`, 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.
+
+## 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
 
 * [AWS SDK for PHP on Github](http://github.com/aws/aws-sdk-php/)
 * [AWS SDK for PHP website](http://aws.amazon.com/sdkforphp/)