Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 0 additions & 11 deletions .gitpod.Dockerfile

This file was deleted.

19 changes: 0 additions & 19 deletions .gitpod.yml

This file was deleted.

1 change: 0 additions & 1 deletion .gitpod_requirements.in

This file was deleted.

85 changes: 0 additions & 85 deletions .gitpod_requirements.txt

This file was deleted.

8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
- [API reference documentation](#api-reference-documentation)
- [Licensing](#licensing)

<!-- markdownlint-disable MD025 -->
# Contributing Guidelines
<!-- markdownlint-disable MD025 -->

<!-- markdownlint-disable MD013 -->
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.
Expand Down Expand Up @@ -96,13 +98,9 @@ timeline

### Dev setup

[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)

Firstly, [fork the repository](https://github.com/aws-powertools/powertools-lambda-python/fork).

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.

Alternatively, you can use `make dev` within your local virtual environment.
You can use `make dev` within your local virtual environment to setup your development environment.

To send us a pull request, please follow these steps:

Expand Down
5 changes: 0 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ dev-quality-code:
poetry install --extras "all redis datamasking valkey"
pre-commit install

dev-gitpod:
pip install --upgrade pip poetry
poetry install --extras "all redis datamasking valkey"
pre-commit install

format-check:
poetry run ruff format aws_lambda_powertools tests examples --check

Expand Down
20 changes: 2 additions & 18 deletions docs/contributing/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Setting up your development environment for contribution

[![Join our Discord](https://img.shields.io/badge/Discord-Join_Community-7289da.svg)](https://discord.gg/B8zZKbbyET){target="_blank"}

This page describes how to setup your development environment (Cloud or locally) to contribute to Powertools for AWS Lambda.
This page describes how to setup your development environment to contribute to Powertools for AWS Lambda.

<center>
```mermaid
Expand All @@ -22,7 +22,7 @@ graph LR
!!! question "First time contributing to an open-source project ever?"
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"}.

Unless you're using the pre-configured Cloud environment, you'll need the following installed:
You'll need the following installed:

* [GitHub account](https://github.com/join){target="_blank" rel="nofollow"}. You'll need to be able to fork, clone, and contribute via pull request.
* [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).
Expand All @@ -35,24 +35,8 @@ Unless you're using the pre-configured Cloud environment, you'll need the follow
* [AWS Account bootstrapped with CDK](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html){target="_blank"}
* [AWS CLI installed and configured](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)

## Cloud environment

> **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.

To use a pre-configured environment, replace `YOUR_USERNAME` with your GitHub username or organization.

```bash
https://gitpod.io/#https://github.com/YOUR_USERNAME/powertools-lambda-python #(1)!
```

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`

Once provisioned, it'll install all development dependencies and tools you'll need to contribute.

## Local environment

> Assuming you've got all [requirements](#requirements).

You can use `make dev` to create a local virtual environment and install all dependencies locally.

!!! note "Curious about what `make dev` does under the hood?"
Expand Down