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
Copy file name to clipboardExpand all lines: docs/contributing/setup.md
+7-27Lines changed: 7 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -24,16 +24,16 @@ graph LR
24
24
25
25
Unless you're using the pre-configured Cloud environment, you'll need the following installed:
26
26
27
-
*[x][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
-
*[x][Python 3.8+](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).
29
-
*[x][Docker](https://docs.docker.com/engine/install/){target="_blank" rel="nofollow"}. We use it to run documentation linters and non-Python tooling.
30
-
*[x][Fork the repository](https://github.com/aws-powertools/powertools-lambda-python/fork). You'll work against your fork of this repository.
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
+
*[Python 3.8+](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).
29
+
*[Docker](https://docs.docker.com/engine/install/){target="_blank" rel="nofollow"}. We use it to run documentation linters and non-Python tooling.
30
+
*[Fork the repository](https://github.com/aws-powertools/powertools-lambda-python/fork). You'll work against your fork of this repository.
31
31
32
32
??? note "Additional requirements if running end-to-end tests"
* [AWS Account bootstrapped with CDK](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html){target="_blank"}
36
+
* [AWS CLI installed and configured](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
37
37
38
38
## Cloud environment
39
39
@@ -65,23 +65,3 @@ You might find useful to run both the documentation website and the API referenc
65
65
***Docs website**: `make docs-local`
66
66
* If you prefer using Docker: `make docs-local-docker`
67
67
***API reference**: `make docs-api-local`
68
-
69
-
## Sending a pull request
70
-
71
-
!!! note "First time creating a Pull Request? Keep [this document handy.](https://help.github.com/articles/creating-a-pull-request/){target='blank' rel='nofollow'}"
72
-
73
-
Before sending us a pull request, please ensure that:
74
-
75
-
1. You are working against the latest source on the **develop** branch.
76
-
2. You check existing [open, and recently merged](https://github.com/aws-powertools/powertools-lambda-python/pulls?q=is%3Apr+is%3Aopen%2Cmerged+sort%3Aupdated-desc){target="_blank" rel="nofollow"} pull requests to make sure someone else hasn't addressed the problem already.
77
-
3. You open an [issue](https://github.com/aws-powertools/powertools-lambda-python/issues/new/choose){target="_blank" rel="nofollow"} before you begin any implementation. We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
78
-
4. Create a new branch named after the change you are contributing _e.g._`feat/logger-debug-sampling`
79
-
80
-
**Ready?**
81
-
82
-
These are the steps to send a pull request:
83
-
84
-
1. Run all code quality, tests, and baseline checks: `make pr`
85
-
2. Commit to your fork using clear commit messages. Don't worry about typos, we will squash all commits during merge.
86
-
3. Send us a pull request with a [conventional semantic title](https://github.com/aws-powertools/powertools-lambda-python/pull/67). We prepared a set of questions you can answer in GitHub User Interface to make reviewing easier.
87
-
4. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
0 commit comments