# Contribution Guidelines

Thank you for considering contributing to this project! Your help is greatly appreciated. Please follow these guidelines to ensure a smooth contribution process.

## How to Contribute

1. **Fork the repository**: Click the "Fork" button at the top right of this repository to create a copy of the repository in your GitHub account.

2. **Clone your fork**: Clone your forked repository to your local machine.
    ```sh
    git clone https://github.com/BreizhHardware/ntfy_alerts.git
    cd ntfy_alerts
    ```

3. **Create a new branch**: Create a new branch for your feature or bugfix.
    ```sh
    git checkout -b feat/my-feature-branch
    ```

4. **Make your changes**: Make your changes to the codebase. Ensure your code follows the project's coding standards and includes appropriate tests.

5. **Commit your changes**: Commit your changes with a clear and concise commit message using conventional commit.
    ```sh
    git add .
    git commit -m "feat: add feature X"
    ```

6. **Push to your fork**: Push your changes to your forked repository.
    ```sh
    git push origin feat/my-feature-branch
    ```

7. **Create a Pull Request**: Go to the original repository and create a pull request from your forked repository. Provide a clear description of your changes and the problem they solve.

## Code Style

- Follow the existing code style and conventions.
- Write clear and concise comments where necessary.
- Ensure your code is well-documented.

## Testing

- Write tests for any new features or bug fixes.
- Ensure all tests pass before submitting your pull request.

## Reporting Issues

If you find a bug or have a feature request, please create an issue on the GitHub repository. Provide as much detail as possible to help us understand and address the issue.

## Code of Conduct

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 contributing!