You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your interest in contributing to our project. Whether it's a [bug report](https://github.com/aws-powertools/powertools-lambda-python/issues/new?assignees=&labels=bug%2Ctriage&projects=&template=bug_report.yml&title=Bug%3A+TITLE), [new feature](https://github.com/aws-powertools/powertools-lambda-python/issues/new?assignees=&labels=feature-request%2Ctriage&projects=&template=feature_request.yml&title=Feature+request%3A+TITLE), [correction](https://github.com/aws-powertools/powertools-lambda-python/issues/new/choose), or [additional documentation](https://github.com/aws-powertools/powertools-lambda-python/issues/new?assignees=&labels=documentation%2Ctriage&projects=&template=documentation_improvements.yml&title=Docs%3A+TITLE), we greatly value feedback and contributions from our community.
Firstly, [fork the repository](https://github.com/aws-powertools/powertools-lambda-python/fork).
102
102
103
-
To setup your development environment, we recommend using our pre-configured Cloud environment: <https://gitpod.io/#https://github.com/YOUR_USERNAME/aws-lambda-powertools-python>. Replace YOUR_USERNAME with your GitHub username or organization so the Cloud environment can target your fork accordingly.
104
-
105
-
Alternatively, you can use `make dev` within your local virtual environment.
103
+
You can use `make dev` within your local virtual environment to setup your development environment.
106
104
107
105
To send us a pull request, please follow these steps:
This page describes how to setup your development environment (Cloud or locally) to contribute to Powertools for AWS Lambda.
10
+
This page describes how to setup your development environment to contribute to Powertools for AWS Lambda.
11
11
12
12
<center>
13
13
```mermaid
@@ -22,7 +22,7 @@ graph LR
22
22
!!! question "First time contributing to an open-source project ever?"
23
23
Read this [introduction on how to fork and clone a project on GitHub](https://docs.github.com/en/get-started/quickstart/contributing-to-projects){target="_blank" rel="nofollow"}.
24
24
25
-
Unless you're using the pre-configured Cloud environment, you'll need the following installed:
25
+
You'll need the following installed:
26
26
27
27
*[GitHub account](https://github.com/join){target="_blank" rel="nofollow"}. You'll need to be able to fork, clone, and contribute via pull request.
28
28
*[Python 3.10+](https://www.python.org/downloads/){target="_blank" rel="nofollow"}. Pick any version supported in [AWS Lambda runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).
@@ -35,24 +35,8 @@ Unless you're using the pre-configured Cloud environment, you'll need the follow
35
35
* [AWS Account bootstrapped with CDK](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html){target="_blank"}
36
36
* [AWS CLI installed and configured](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
37
37
38
-
## Cloud environment
39
-
40
-
> **NOTE**. Be mindful of [Gitpod pricing structure](https://www.gitpod.io/pricing){target="_blank" rel="nofollow"} for long-running contributions. When in doubt, use the local environment below.
41
-
42
-
To use a pre-configured environment, replace `YOUR_USERNAME` with your GitHub username or organization.
1. For example, my username is `heitorlessa`. <br><br> Therefore, my final URL should be `https://gitpod.io/#https://github.com/heitorlessa/powertools-lambda-python`
49
-
50
-
Once provisioned, it'll install all development dependencies and tools you'll need to contribute.
51
-
52
38
## Local environment
53
39
54
-
> Assuming you've got all [requirements](#requirements).
55
-
56
40
You can use `make dev` to create a local virtual environment and install all dependencies locally.
57
41
58
42
!!! note "Curious about what `make dev` does under the hood?"
0 commit comments