Getting help

You have a question about Citry, or hit something that looks like a bug. Questions and bug reports both go to the GitHub repository at citry-dev/citry. This page shows where to post and what to include.

Search first

Someone may have hit the same thing already. Before you post, search:

• The existing issues and discussions for your question or the exact error message.
• This documentation, with the search at the top of the page.

Ask a question

If you cannot find an answer, ask in Discussions. Keep issues for bug reports and feature requests.

To get a useful answer quickly, include:

• What you are trying to do.
• A short component or template that shows the problem.
• What you expected to happen, and what happened instead.

Report a bug

Open a bug report with enough detail for someone else to reproduce the problem:

• The citry and citry-core versions. pip show citry citry-core prints both.
• Your Python version and operating system.
• The smallest component and render call that triggers the problem.
• The full error message and traceback.

A small example that we can run is the biggest single thing that speeds up a fix.

Report a security issue

Do not open a public issue for a security problem. Report it privately through GitHub's private vulnerability reporting.