Contributing

Contributing to Update-Watcher

Thank you for your interest in contributing to Update-Watcher. Whether you are reporting a bug, suggesting a feature, improving documentation, or writing code, every contribution is welcome.

Ways to Contribute

Bug reports – Open an issue on GitHub with steps to reproduce
Feature requests – Suggest new checkers, notifiers, or improvements via issues
Documentation – Fix typos, improve explanations, or add examples
Code – Add new checkers, notifiers, or improve existing functionality

Getting Started

Fork the repository on GitHub

Clone your fork

Terminal

git clone https://github.com/YOUR_USERNAME/update-watcher.git

Create a feature branch

Terminal

git checkout -b feature/my-feature

Make your changes

Run tests

Terminal

make test

Push and open a Pull Request

Guides

Architecture Overview

Understand the codebase structure and design patterns.

Adding a Checker

Step-by-step guide to implementing a new update checker.

Adding a Notifier

Step-by-step guide to implementing a new notification backend.

Development Workflow

Build, test, lint, and release process.