Contributing Guide

Thank you for considering contributing to our project! Below are the guidelines to help you get started.

Getting Started

1. Fork the Repository: Create a fork of the repository on GitHub.
2. Clone Your Fork: Clone your forked repository to your local machine.
3. Create a New Branch: For every feature or bug fix, create a new branch from the master branch.

Coding Standards

• Follow the Style Guide: Our project follows PEP 8 for Python code.
• Commit Messages: Use clear and concise commit messages.

Testing

• Write Tests: We encourage writing tests for your code changes.
• Run Tests: Before submitting a pull request, make sure all tests pass.

Submitting Pull Requests

1. Title: Use a clear and concise title for your pull request.
2. Description: Provide a detailed description of what your changes do.
3. Review: Your pull request will be reviewed by the maintainers.

Resources

• Developer Guide - More detailed information for developers.
• Code of Conduct - Our code of conduct for contributing.

Contributing