mirror of
https://github.com/swift-server/swift-aws-lambda-runtime.git
synced 2026-06-02 07:27:33 +00:00
Sébastien StormacqandSebastien Stormacq
e58d89148c
- Adjust notice, security reporting, code of conduct, contribution process to the standard AWS documents - Adjust GitHub issue templates to AWS standard ones. - Adjust the license header in all source files --------- Co-authored-by: Sebastien Stormacq <stormacq@amazon.lu>
57 lines
3.2 KiB
Markdown
57 lines
3.2 KiB
Markdown
# Contributing Guidelines
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
|
|
## Reporting Bugs/Feature Requests
|
|
|
|
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
|
|
|
|
When filing an issue, please check [existing open](https://github.com/awslabs/swift-aws-lambda-runtime/issues), or [recently closed](https://github.com/awslabs/swift-aws-lambda-runtime/issues?q=is%3Aissue%20state%3Aclosed), 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:
|
|
|
|
* 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 *main* 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:
|
|
|
|
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 GitHub issue labels (looking at any ['good first issue'](https://github.com/awslabs/swift-aws-lambda-runtime/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) 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
|
|
opensource-codeofconduct@amazon.com with any additional questions or comments.
|
|
|
|
|
|
## Licensing
|
|
|
|
See the [LICENSE](https://github.com/awslabs/swift-aws-lambda-runtime/blob/main/LICENSE.txt) file for our project's licensing. We will ask you 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. |