Contributing to Django AWS SES

Thank you for your interest in contributing to Django AWS SES! This guide outlines how to set up the project, run tests, and submit changes.

Getting Started

Clone the Repository:

git clone https://git-vault.zeeksgeeks.com/zeeksgeeks/django_aws_ses
cd django_aws_ses

Set Up a Virtual Environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Install Dependencies:

pip install -r requirements.txt
pip install -r requirements-dev.txt

Configure a Test Django Project:
- Create a Django project or use an existing one.
- Add 'django_aws_ses' to INSTALLED_APPS in settings.py.
- Apply migrations:
```
python manage.py migrate
```

Ensure test dependencies are installed:
```
pip install -r requirements-dev.txt
```
Run the test suite:
```
python manage.py test django_aws_ses
```
Check test coverage (optional):
```
pytest --cov=django_aws_ses
```

Create a Feature Branch:

git checkout -b feature/your-feature-name

Follow Coding Guidelines:
- Write clear, concise code with docstrings.
- Ensure compatibility with Python 3.8+ and Django 3.2+.
- Add tests for new functionality.
Test Your Changes:
- Run the full test suite to ensure no regressions.
- Test manually in a Django project if needed.

Commit Changes:

git add .
git commit -m "Add your descriptive commit message"

Push and Create a Pull Request:
```
git push origin feature/your-feature-name
```
- Create a pull request on the repository.
- Describe your changes and reference any related issues.

Use the repository’s issue tracker to report bugs or suggest features.
Provide detailed information, including steps to reproduce and environment details.

By contributing, you agree that your contributions will be licensed under the MIT License.

For questions, contact Ray Jessop at development@zeeksgeeks.com.