|
| 1 | +# Contributing |
| 2 | + |
| 3 | +We welcome contributions to the project. This document provides information and |
| 4 | +guidelines for contributing. |
| 5 | + |
| 6 | +## Development Environment |
| 7 | + |
| 8 | +This repository includes a configuration for a development container using the |
| 9 | +[VS Code Remote - Containers extension](https://code.visualstudio.com/docs/remote/containers). |
| 10 | +This setup allows you to develop within a Docker container that already has all |
| 11 | +the necessary tools and dependencies installed. |
| 12 | + |
| 13 | +The development container is based on Ubuntu 22.04 (Jammy) and includes the |
| 14 | +following tools: |
| 15 | + |
| 16 | +- AWS CLI |
| 17 | +- Python v3.8 |
| 18 | +- Python Packages: `boto3`, `black` |
| 19 | +- Docker CLI |
| 20 | +- Terraform |
| 21 | + |
| 22 | +### Prerequisites |
| 23 | + |
| 24 | +- [Docker](https://www.docker.com/products/docker-desktop) installed on your |
| 25 | + local machine. |
| 26 | +- [Visual Studio Code](https://code.visualstudio.com/) installed on your |
| 27 | + local machine. |
| 28 | +- [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) |
| 29 | + for Visual Studio Code. |
| 30 | + |
| 31 | +### Usage |
| 32 | + |
| 33 | +1. Clone and open this repository: |
| 34 | + |
| 35 | + ```bash |
| 36 | + git clone https://github.com/sgtoj/terraform-aws-eip-manager.git |
| 37 | + code terraform-aws-eip-manager |
| 38 | + ``` |
| 39 | + |
| 40 | +2. When prompted to "Reopen in Container", click "Reopen in Container". This |
| 41 | + will start building the Docker image for the development container. If you're |
| 42 | + not prompted, you can open the Command Palette (F1 or Ctrl+Shift+P), and run |
| 43 | + the "Remote-Containers: Reopen Folder in Container" command. |
| 44 | +
|
| 45 | +3. After the development container is built and started, you can use the |
| 46 | + Terminal in Visual Studio Code to interact with the container. All commands |
| 47 | + you run in the Terminal will be executed inside the container. |
| 48 | +
|
| 49 | +### Troubleshooting |
| 50 | +
|
| 51 | +If you encounter any issues while using the development container, you can try |
| 52 | +rebuilding the container. To do this, open the Command Palette and run the |
| 53 | +"Remote-Containers: Rebuild Container" command. |
| 54 | +
|
| 55 | +## Contribution Guidelines |
| 56 | +
|
| 57 | +We appreciate your interest in contributing to the project. Here are some |
| 58 | +guidelines to help ensure your contributions are accepted. |
| 59 | +
|
| 60 | +### Issues |
| 61 | +
|
| 62 | +- Use the GitHub issue tracker to report bugs or propose new features. |
| 63 | +- Before submitting a new issue, please search to make sure it has not already |
| 64 | + been reported. If it has, add a comment to the existing issue instead of |
| 65 | + creating a new one. |
| 66 | +- When reporting a bug, include as much detail as you can. Include the version |
| 67 | + of the module you're using, what you expected to happen, what actually |
| 68 | + happened, and steps to reproduce the bug. |
| 69 | + |
| 70 | +### Pull Requests |
| 71 | + |
| 72 | +- Submit your changes as a pull request. |
| 73 | +- All pull requests should be associated with an issue. If your change isn't |
| 74 | + associated with an existing issue, please create one before submitting a pull |
| 75 | + request. |
| 76 | +- In your pull request, include a summary of the changes, the issue number it |
| 77 | + resolves, and any additional information that might be helpful for |
| 78 | + understanding your changes. |
| 79 | +- Make sure your changes do not break any existing functionality. If your |
| 80 | + changes require updates to existing tests or the addition of new ones, include |
| 81 | + those in your pull request. |
| 82 | +- Follow the existing code style. We use a linter to maintain code quality, so |
| 83 | + make sure your changes pass the linter checks. |
| 84 | +
|
| 85 | +Thank you for your contributions! |
0 commit comments