Contributing¶
Contributions to the ZeptoMail Python API are welcome! Here's how you can help:
Development Setup¶
-
Clone the repository:
-
Create a virtual environment and install dependencies:
Running Tests¶
Run the tests using pytest:
Building Documentation¶
The documentation is built using MkDocs with the mkdocstrings plugin:
To serve the documentation locally:
Code Style¶
This project follows PEP 8 style guidelines. You can check your code with:
Pull Request Process¶
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
Adding New Features¶
When adding new features:
- Add appropriate docstrings following Google style
- Write tests for your new feature
- Update the documentation if necessary
- Ensure all tests pass before submitting a PR