Skip to content

Commit 942b496

Browse files
committed
Update readme and contribution guide.
1 parent 073d829 commit 942b496

File tree

2 files changed

+29
-31
lines changed

2 files changed

+29
-31
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
# Contributing Guidelines
22

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

6-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7-
information to effectively respond to your bug report or contribution.
5+
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.
86

97

108
## Reporting Bugs/Feature Requests
119

1210
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1311

14-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
12+
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:
1613

1714
* A reproducible test case or series of steps
1815
* The version of our code being used
@@ -21,23 +18,11 @@ reported the issue. Please try to include as much information as you can. Detail
2118

2219

2320
## Contributing via Pull Requests
24-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
21+
This repository contains the `.tar.xz` layers, and the Dockerfiles, used to create the base images.
2522

26-
1. You are working against the latest source on the *main* branch.
27-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
23+
The Dockerfiles in this repository allow you to recreate or modify the base images using your own build process. We will accept pull requests on documentation, examples, bug fixes and the Dockerfiles. We will also accept issues and feedback to add or remove software from the images.
2924

30-
To send us a pull request, please:
31-
32-
1. Fork the repository.
33-
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.
34-
3. Ensure local tests pass.
35-
4. Commit to your fork using clear commit messages.
36-
5. Send us a pull request, answering any default questions in the pull request interface.
37-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38-
39-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40-
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
25+
However, our goal is to provide images that are optimized for performance on the Lambda service.
4126

4227

4328
## Finding contributions to work on
@@ -56,4 +41,4 @@ If you discover a potential security issue in this project we ask that you notif
5641

5742
## Licensing
5843

59-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
44+
See the [LICENSE](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.

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
1-
## My Project
1+
## AWS Lambda Base Container Images
22

3-
TODO: Fill this README out!
3+
AWS provided base images for Lambda contain all the required components to run your functions packaged as container images on AWS Lambda.
4+
These base images contain the Amazon Linux Base operating system, the runtime for a given language, dependencies and the Lambda Runtime Interface Client (RIC), which implements the Lambda [Runtime API](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-api.html).
5+
The Lambda Runtime Interface Client allows your runtime to receive requests from and send requests to the Lambda service.
46

5-
Be sure to:
7+
To learn more about how these images are used, check out the AWS documentation on how to [Create an image from an AWS base image for Lambda](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-create-1).
68

7-
* Change the title in this README
8-
* Edit your repository description on GitHub
9+
### Maintenance policy
910

10-
## Security
11+
AWS will regularly provide security patches and other updates for these base images.
12+
These images are similar to the AWS Lambda execution environment on the cloud to allow customers to easily packaging functions to the container image.
13+
However, we may choose to optimize the container images by changing the components or dependencies included.
14+
When deployed to AWS Lambda these images will be run as-is.
1115

12-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
16+
This is more of an *artifact store* than a Git repository, for reasons explained later. Please note that **branches other than `main` are regularly force-pushed, and content may disappear without warning**.
1317

14-
## License
18+
## What we're doing here
1519

16-
This project is licensed under the Apache-2.0 License.
20+
As soon as new AWS Lambda base images are available, an automated process snapshots the layers and configuration used to create these images and force-pushes them to this repository.
21+
22+
For examples, please see other branches in this repository.
23+
24+
Committed alongside the Dockerfiles in the branches are the tarballs, which balloon the repository size. Thus, we force-push branches that contain the tarballs.
1725

26+
Although we force-push the files away, the older versions of our images remain present on DockerHub and Amazon ECR.
27+
28+
## Licence
29+
30+
This project is licensed under the Apache-2.0 License.

0 commit comments

Comments
 (0)