Issue Ticca Portal / Contribute
Sign in

Contribute

The SDK is open source and community-driven. Its goal is to make monitoring a Django project simple โ€” and it grows through contributions of every kind. You do not need to be a Django expert to help.

Ways to help

๐Ÿ› Report bugs Open an issue with the traceback and the version of the SDK you are running.
๐Ÿ’ก Suggest features Describe the problem you have, not only the solution you want.
๐Ÿ“– Improve the docs Fixes, examples and usage recipes are genuinely welcome.
๐Ÿ”Œ Add a health check MongoDB, S3, SMTP, Elasticsearch โ€” implement it under check/ and register it.
๐Ÿ”” Build integrations Hook incident_logged / incident_resolved to Slack, email or another tracker.
๐Ÿงช Write tests Triage issues, or โญ star and share the project.

Getting set up

git clone https://github.com/wilsenmuts/django-issue-ticca.git
cd django-issue-ticca
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

export DJANGO_SETTINGS_MODULE=tests.settings
export PYTHONPATH=src

python -m django test django_issue_ticca   # tests
ruff check src tests                       # lint

Before opening a pull request:

python -m django makemigrations --check --dry-run
python -m django check

Pull request checklist

  • Tests cover the change, and the suite passes.
  • New settings are documented in the README and have sane defaults.
  • Optional subsystems degrade gracefully โ€” they must never make a system unhealthy just because they are absent.
  • Migrations are committed and current.
  • Commit messages say why, not only what.

New here?

Look for issues labelled good first issue, or just open an issue and ask โ€” questions are welcome. Please be respectful and constructive; the aim is a friendly place to contribute.

Support the project

If this saves you time, you can support continued development.

โ˜• Buy me a coffee

Questions about this portal?

Reach the maintainer directly โ€” the Talk to dev page opens a pre-filled email.

wilsonmutebi41@gmail.com