Contributing to snotify

Thank you for considering contributing to snotify! We welcome contributions from the community to help improve the project.

Getting Started

Fork the repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository under your own GitHub account.

Clone your fork: Clone your forked repository to your local machine.

git clone https://github.com/your-username/snotify.git
cd snotify

Create a branch: Create a new branch for your feature or bug fix.
```
git checkout -b feature/your-feature-name
```

Install dependencies: Install the required Python packages for development.
```
pip install -r requirements.txt
pip install -r requirements-dev.txt
```
Set up pre-commit hooks: We use pre-commit hooks to ensure code quality. Install the hooks by running:
```
pre-commit install
```
This will automatically run checks on your code before each commit, including formatting with Black, linting with Ruff, and other checks.

Make your changes: Implement your feature or bug fix.
Run tests: Ensure that all tests pass by running:
```
pytest
```
Commit your changes: Commit your changes with a descriptive commit message.
```
git add .
git commit -m "Add feature: your feature description"
```
Push your branch: Push your branch to your forked repository.
```
git push origin feature/your-feature-name
```
Create a pull request: Go to the original repository and create a pull request from your branch.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Thank you for your contributions!