Skip to content

chore: sync from internal (rie-private-to-public) #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aws-sam-tooling-bot wants to merge 1 commit into
base: develop
Choose a base branch
from
+78 −15
Open

chore: sync from internal (rie-private-to-public) #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!--
Thank you for taking the time to send this.

Please read this first: this repository is generated from an internal AWS source of truth, so we
cannot merge pull requests into it directly. We still want your proposal. Yours will be read and
treated as a reference for the change you are describing, and if we adopt your solution we make the
corresponding change internally and credit you in the release notes for the version that ships it.

If what you want is a behaviour change rather than a specific patch, an issue describing your use
case is more effective than a pull request. See CONTRIBUTING.md.
-->

#### What does this change do?


#### Why is it needed? What is the use case?


#### How did you test it?

<!-- Local tests pass through `make integ-tests-and-compile`. -->


#### Checklist

- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md) and understand this pull request will be used
as a reference rather than merged directly
- [ ] I opened an issue first if this is a significant change
- [ ] This change is limited to the behaviour described above, with no unrelated reformatting
- [ ] Local tests pass through `make integ-tests-and-compile`

By submitting this pull request, I confirm that my contribution is made under the terms of the
[Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
47 changes: 32 additions & 15 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,17 @@ 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.

**Please note:** this repository is generated from an internal AWS source of truth, which means we are unable to merge
pull requests into it directly. We very much still want your input -- see
[How we handle contributions](#how-we-handle-contributions) for what happens to an issue or pull request you open, and
how you get credit for a change we adopt.


## Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.
We welcome you to use the GitHub issue tracker to report bugs or suggest features. Issues are the most effective way to
reach us: a feature request that describes your use case can be picked up and implemented, whereas a pull request cannot
be merged as-is.

When filing an issue, please check existing open, or recently closed, 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:
Expand All @@ -20,25 +27,34 @@ reported the issue. Please try to include as much information as you can. Detail
* Anything unusual about your environment or deployment


## Contributing via Pull Requests
This repository contains the source code and examples for the Runtime Interface Emulator. We will accept pull requests on documentation, examples, bug fixes and the Dockerfiles. We will also accept pull requests, issues and feedback on improvements to the Runtime Interface Emulator. However, our priority will be to maintain fidelity with AWS Lambda’s Runtime Interface on the cloud.
## How we handle contributions

This repository contains the source code and examples for the Runtime Interface Emulator. The code here is generated from
an internal AWS repository, which is the source of truth, and changes flow outward from there. Because of that we cannot
merge a pull request into this repository, even one we agree with.

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
That does not mean we don't want it. Here is what each kind of contribution gets you:

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.
* **Feature requests and bug reports are welcome, and are the most useful thing you can send us.** Open an issue
describing the behaviour you want and the use case behind it. Our priority is maintaining fidelity with AWS Lambda's
Runtime Interface in the cloud, so a clear use case is what lets us weigh a change against that.
* **Pull requests are welcome as a reference.** We read them, and a working patch is often the clearest way to explain a
proposal. It will not be merged directly. If we adopt your solution, we make the corresponding change in the internal
repository, and it reaches this repository through the next sync.
* **If we adopt your change, we credit you in the release notes** for the version that ships it.

To send us a pull request, please:
So that we can act on 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 through `make integ-tests-and-compile`
4. Commit to your fork using clear commit messages.
5. Send us a pull request, answering any default questions in the pull request interface.
1. Open an issue first to discuss any significant work -- we would hate for your time to be wasted on something we
cannot take.
2. Work against the latest source on the *main* branch.
3. Check existing open, and recently closed, pull requests and issues to make sure someone else hasn't raised it already.
4. Focus on the specific change you are proposing. If you also reformat all the code, it will be hard for us to see what
you are actually suggesting.
5. Ensure local tests pass through `make integ-tests-and-compile`.
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
GitHub provides additional documentation 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/).


Expand All @@ -58,4 +74,5 @@ If you discover a potential security issue in this project we ask that you notif

## Licensing

See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your
contribution, including for a pull request we adopt rather than merge.
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Lambda’s orchestrator, or security and authentication configurations. You can
* [To test an image without adding RIE to the image](#to-test-an-image-without-adding-rie-to-the-image)
* [How to configure](#how-to-configure)
* [Level of support](#level-of-support)
* [Contributing](#contributing)
* [Security](#security)
* [License](#license)

Expand Down Expand Up @@ -187,6 +188,18 @@ configurations that will not be emulated by this component.
* The component does _not_ support X-ray and other Lambda integrations locally.
* The component supports only Linux, for x86-64 and arm64 architectures.

## Contributing

We welcome feature requests and bug reports through the GitHub issue tracker, and they are the most effective way to
reach us.

This repository is generated from an internal AWS source of truth, so we are unable to merge pull requests into it
directly. You are still welcome to open one: we read them, and a working patch is often the clearest way to explain a
proposal. It is treated as a reference rather than something we merge, and if we adopt your solution we make the change
in the internal repository and credit you in the release notes for the version that ships it.

See [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
Expand Down