Skip to content

Commit 8f076dc

Browse files
docs: point docs to aws/aws-lambda-rust-runtime instead of awslabs/
1 parent 578c533 commit 8f076dc

File tree

180 files changed

+24596
-13
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

180 files changed

+24596
-13
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
📬 *Issue #, if available:*
2+
3+
✍️ *Description of changes:*
4+
5+
🔏 *By submitting this pull request*
6+
7+
- [ ] I confirm that I've ran `cargo +nightly fmt`.
8+
- [ ] I confirm that I've ran `cargo clippy --fix`.
9+
- [ ] I confirm that I've made a best effort attempt to update all relevant documentation.
10+
- [ ] I confirm that my contribution is made under the terms of the Apache 2.0 license.

CODE_OF_CONDUCT.md.bak

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Code of Conduct
2+
3+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
4+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
5+
[email protected] with any additional questions or comments.

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ information to effectively respond to your bug report or contribution.
1010

1111
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1212

13-
When filing an issue, please check [existing open](https://github.com/awslabs/aws-lambda-rust-runtime/issues), or [recently closed](https://github.com/awslabs/aws-lambda-rust-runtime/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
13+
When filing an issue, please check [existing open](https://github.com/aws/aws-lambda-rust-runtime/issues), or [recently closed](https://github.com/aws/aws-lambda-rust-runtime/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
1414
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1515

1616
* A reproducible test case or series of steps
@@ -40,7 +40,7 @@ GitHub provides additional document on [forking a repository](https://help.githu
4040

4141
## Finding contributions to work on
4242

43-
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/awslabs/aws-lambda-rust-runtime/labels/help%20wanted) issues is a great place to start.
43+
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-lambda-rust-runtime/labels/help%20wanted) issues is a great place to start.
4444

4545
## Code of Conduct
4646

@@ -54,6 +54,6 @@ If you discover a potential security issue in this project we ask that you notif
5454

5555
## Licensing
5656

57-
See the [LICENSE](https://github.com/awslabs/aws-lambda-rust-runtime/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
57+
See the [LICENSE](https://github.com/aws/aws-lambda-rust-runtime/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
5858

5959
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

CONTRIBUTING.md.bak

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing Guidelines
2+
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.
5+
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.
8+
9+
## Reporting Bugs/Feature Requests
10+
11+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
12+
13+
When filing an issue, please check [existing open](https://github.com/awslabs/aws-lambda-rust-runtime/issues), or [recently closed](https://github.com/awslabs/aws-lambda-rust-runtime/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
14+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
15+
16+
* A reproducible test case or series of steps
17+
* The version of our code being used
18+
* Any modifications you've made relevant to the bug
19+
* Anything unusual about your environment or deployment
20+
21+
## Contributing via Pull Requests
22+
23+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
24+
25+
1. You are working against the latest source on the *main* branch.
26+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
27+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
28+
29+
To send us a pull request, please:
30+
31+
1. Fork the repository.
32+
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.
33+
3. Ensure local tests pass.
34+
4. Commit to your fork using clear commit messages and ensure any Rust source files have been formatted with the [rustfmt tool](https://github.com/rust-lang/rustfmt#quick-start)
35+
5. Send us a pull request, answering any default questions in the pull request interface.
36+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
37+
38+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
39+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
40+
41+
## Finding contributions to work on
42+
43+
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/awslabs/aws-lambda-rust-runtime/labels/help%20wanted) issues is a great place to start.
44+
45+
## Code of Conduct
46+
47+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
48+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
49+
[email protected] with any additional questions or comments.
50+
51+
## Security issue notifications
52+
53+
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.
54+
55+
## Licensing
56+
57+
See the [LICENSE](https://github.com/awslabs/aws-lambda-rust-runtime/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
58+
59+
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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Rust Runtime for AWS Lambda
22

3-
[![Build Status](https://github.com/awslabs/aws-lambda-rust-runtime/actions/workflows/check-examples.yml/badge.svg)](https://github.com/awslabs/aws-lambda-rust-runtime/actions)
3+
[![Build Status](https://github.com/aws/aws-lambda-rust-runtime/actions/workflows/check-examples.yml/badge.svg)](https://github.com/aws/aws-lambda-rust-runtime/actions)
44

55
This package makes it easy to run AWS Lambda Functions written in Rust. This workspace includes multiple crates:
66

@@ -113,7 +113,7 @@ async fn handler(_event: LambdaEvent<()>) -> Result<(), ErrorResponse> {
113113
}
114114
```
115115

116-
We recommend you to use the [thiserror crate](https://crates.io/crates/thiserror) to declare your errors. You can see an example on how to integrate `thiserror` with the Runtime's diagnostics in our [example repository](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples/basic-error-thiserror)
116+
We recommend you to use the [thiserror crate](https://crates.io/crates/thiserror) to declare your errors. You can see an example on how to integrate `thiserror` with the Runtime's diagnostics in our [example repository](https://github.com/aws/aws-lambda-rust-runtime/tree/main/examples/basic-error-thiserror)
117117

118118
### Anyhow, Eyre, and Miette
119119

@@ -129,7 +129,7 @@ async fn handler(_event: LambdaEvent<Request>) -> Result<(), Diagnostic> {
129129
}
130130
```
131131

132-
You can see more examples on how to use these error crates in our [example repository](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/examples/basic-error-error-crates-integration).
132+
You can see more examples on how to use these error crates in our [example repository](https://github.com/aws/aws-lambda-rust-runtime/tree/main/examples/basic-error-error-crates-integration).
133133

134134
### Graceful shutdown
135135

@@ -370,7 +370,7 @@ Now you can use the `cargo lambda invoke` to send requests to your function. For
370370
cargo lambda invoke <lambda-function-name> --data-ascii '{ "command": "hi" }'
371371
```
372372

373-
Running the command on a HTTP function (Function URL, API Gateway, etc) will require you to use the appropriate scheme. You can find examples of these schemes [here](https://github.com/awslabs/aws-lambda-rust-runtime/tree/main/lambda-http/tests/data). Otherwise, you will be presented with the following error.
373+
Running the command on a HTTP function (Function URL, API Gateway, etc) will require you to use the appropriate scheme. You can find examples of these schemes [here](https://github.com/aws/aws-lambda-rust-runtime/tree/main/lambda-http/tests/data). Otherwise, you will be presented with the following error.
374374

375375
```rust,no_run
376376
Error: serde_json::error::Error

0 commit comments

Comments
 (0)