Skip to content

Commit

Permalink
Merge pull request #15 from diehlaws/common-files-standardization
Browse files Browse the repository at this point in the history 
Updating common files
  • Loading branch information
@diehlaws
diehlaws authored Aug 6, 2020
2 parents e8b4aab + 1098af2 commit 99e870a
Show file tree
Hide file tree
Showing 2 changed files with 141 additions and 54 deletions.
162 changes: 110 additions & 52 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,61 +1,119 @@
# Contributing Guidelines
# Contributing to the AWS SDK for PHP - Version 3 Upgrade Bridge

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
documentation, we greatly value feedback and contributions from our community.
Thank you for your interest in contributing to our project. 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.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
information to effectively respond to your bug report or contribution.
Jump To:

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

## Reporting Bugs/Feature Requests
## How to contribute

We welcome you to use the GitHub issue tracker to report bugs or suggest features.
*Before you send us a pull request, please be sure that:*

When filing an issue, please check [existing open](https://github.com/aws/aws-sdk-php-v3-bridge/issues), or [recently closed](https://github.com/aws/aws-sdk-php-v3-bridge/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
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.

* A reproducible test case or series of steps
* The version of our code being used
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment


## Contributing via Pull Requests
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

1. You are working against the latest source on the *master* branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:
*Creating a Pull Request*

1. Fork the repository.
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.
3. Ensure local tests pass.
4. Commit to your fork using clear commit messages.
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).


## Finding contributions to work on
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'](https://github.com/aws/aws-sdk-php-v3-bridge/labels/help%20wanted) issues is a great place to start.


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


## Security issue notifications
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.


## Licensing

See the [LICENSE](https://github.com/aws/aws-sdk-php-v3-bridge/blob/master/LICENSE) file for our 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.
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-v3-bridge/issues
[pull-requests]: https://github.com/aws/aws-sdk-php-v3-bridge/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
33 changes: 31 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,18 @@ $sdb = new \Aws\SimpleDb\SimpleDbClient([
$domains = $sdb->listDomains();
```

Jump To:
* [Getting Started](_#Getting-Started_)
* [Getting Help](_#Getting-Help_)
* [Contributing](_#Contributing_)
* [More Resources](_#Resources_)

## Getting Started

Please note that you cannot use the `Aws\Sdk` service locator with SimpleDb.
You must create clients using the `new` keyword.

## Installation
### Installation

This package can be installed via [Composer](http://getcomposer.org) by requiring the
`aws/aws-sdk-php-v3-bridge` package in your project's `composer.json`.
Expand All @@ -40,7 +48,28 @@ Then run a composer update
php composer.phar update
```

## 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-v3-bridge/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-v3-bridge` 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-v3-bridge`, 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/)
Expand Down

0 comments on commit 99e870a

Please sign in to comment.