Skip to content

Commit 4dae5bd

Browse files
Create CONTRIBUTING.md
1 parent a67b654 commit 4dae5bd

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

CONTRIBUTING.md

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Contributing to simple-terraform-backend
2+
3+
We're excited that you're interested in contributing to the simple-terraform-backend project! This document outlines the process for contributing to this project.
4+
5+
## Code of Conduct
6+
7+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before contributing.
8+
9+
## Getting Started
10+
11+
1. Fork the repository on GitHub.
12+
2. Clone your fork locally:
13+
```
14+
git clone https://github.com/your-username/terraform-fastapi-backend.git
15+
cd terraform-fastapi-backend
16+
```
17+
3. Create a new branch for your feature or bug fix:
18+
```
19+
git checkout -b feature/your-feature-name
20+
```
21+
22+
## Setting Up the Development Environment
23+
24+
1. Ensure you have Python 3.7+ installed.
25+
2. Create a virtual environment:
26+
```
27+
python -m venv venv
28+
source venv/bin/activate # On Windows use `venv\Scripts\activate`
29+
```
30+
3. Install the development dependencies:
31+
```
32+
pip install -r requirements.txt
33+
```
34+
35+
## Making Changes
36+
37+
1. Make your changes in your feature branch.
38+
2. Add or update tests as necessary.
39+
3. Ensure all tests pass:
40+
```
41+
pytest
42+
```
43+
4. Update documentation if you've made changes to the API or added new features.
44+
45+
## Commit Guidelines
46+
47+
- Use clear and meaningful commit messages.
48+
- Reference issue numbers in your commit messages if applicable.
49+
- Make sure each commit represents a logical unit of change.
50+
51+
## Submitting a Pull Request
52+
53+
1. Push your changes to your fork on GitHub:
54+
```
55+
git push origin feature/your-feature-name
56+
```
57+
2. Go to the original project repository on GitHub and create a new Pull Request.
58+
3. Describe your changes in detail, referencing any related issues.
59+
4. Wait for a maintainer to review your PR. They may ask for changes or clarifications.
60+
61+
## Code Style
62+
63+
- Follow PEP 8 guidelines for Python code.
64+
- Use type hints where possible.
65+
- Document your functions and classes using docstrings.
66+
67+
## Testing
68+
69+
- Write unit tests for new functionality.
70+
- Ensure all existing tests pass before submitting a PR.
71+
- Aim for high test coverage for new code.
72+
73+
## Documentation
74+
75+
- Update the README.md if you've made changes that affect how the project is used.
76+
- Document new features or changes to existing features in the appropriate places.
77+
78+
## Reporting Bugs
79+
80+
- Use the GitHub Issues tracker to report bugs.
81+
- Describe the bug in detail, including steps to reproduce.
82+
- Include information about your environment (OS, Python version, etc.).
83+
84+
## Requesting Features
85+
86+
- Use the GitHub Issues tracker to suggest new features.
87+
- Clearly describe the feature and its potential benefits.
88+
- Be open to discussion about the feature's implementation.
89+
90+
## Questions?
91+
92+
If you have any questions about contributing, feel free to open an issue for clarification.

0 commit comments

Comments
 (0)