File a Bug

We welcome and appreciate all bug reports! Please use the issue tracker at https://todo.sr.ht/~arx10/procustodibus to file them. You can post new tickets or comment on existing tickets anonymously.

If you register for a SourceHut account, you can also subscribe to all Pro Custodibus ticket updates (by clicking the enable notifications button on the tracker home page), or subscribe to updates for specific tickets only (by clicking the enable notifications button on each ticket’s page).

If the bug you’re reporting is or may expose a security vulnerability in Pro Custodibus, instead of using the issue tracker, please report the bug to security@arcemtene.com. See the Report a Vulnerability page for details.

Before you post a bug report, please scan the first page of the issue tracker for recent reports, and do a quick search for the error message or behavior you’re reporting, to check if someone else has already reported the bug. If so, there’s no need to open a new ticket — but please add additional relevant info as a comment to the existing bug report (like “happens for me too, but on Arch Linux” or “I’m seeing this issue with every user whose username has a numeral in it”). Create a new ticket for each distinct bug you encounter.

Format

When you post a new ticket, please follow this format:

Title Field

One-line summary

Description Field

Short free-form Description (optional)
Environment
Reproduction Steps
Actual Result
Expected Result
Workaround (optional)
Links to related issues, log files, screenshots (optional)

Put the Title in the Title field of the ticket form, and include all other sections in the Description field.

The Description field accepts Markdown formatting (using the CommonMark flavor). There are no length restrictions on this field, so you can enter as much text as you need to fully document the bug.

Use the following sections for your report:

Title

Write a concise, one-line summary for the bug. Use abbreviations and truncated grammar to keep it short, if necessary. It often helps to write the title last, thinking about what keywords someone else would use to try to find this bug, and what makes it unique from other bugs that might be reported.

Description

Optionally, write a one- or two-paragraph description of the bug, including any relevant information not found in the other sections of the bug report.

Environment

Include the version of Pro Custodibus you’re using, the operating system it’s running on, and other relevant tools or applications (like the browser version number you’re using if it’s a bug with the web UI, or the version number of an third-party application if it’s a bug interacting with that application, etc).

Reproduction Steps

List the steps it would take for someone else to reproduce the bug. Assume the other person is a five-year-old, and needs every step detailed literally.

Actual Result

Describe what happens currently when you follow the reproduction steps. Copy-and-paste the exact error message or other erroneous result that’s displayed.

Expected Result

Describe what should have happened when you followed the reproduction steps.

Workaround

Optionally, describe any tricks you’ve discovered that would help someone else who’s also encountered the bug to work around it for the time-being.

Links

Optionally, list links to other notes or resources you think would be helpful, like related issues in the issue tracker, or log files or screenshots you’ve uploaded to other sites like Pastebin or Pasteboard.

Example

Title

can't create a new user with emoji characters in her name

Description

Description
-----------

When I try to create a user with any emoji characters in the user's
display name, Pro Custodibus displays an error message instead of
creating the user. Characters below U+FFFF seem to be working fine.

Environment
-----------

* Pro Custodibus EE 1.2.3
* Ubuntu 22.04 (Linux daphne 5.19.0-1029-aws #30~22.04.1-Ubuntu SMP Thu Jul 13 17:21:19 UTC 2023 aarch64 aarch64 aarch64 GNU/Linux)
* Chrome Version 115.0.5790.170 (Official Build) (x86_64)

Repro Steps
-----------

1. log into Pro Custodibus as an admin user
2. navigate to the Admin > Users page
3. click the Add (plus) icon
4. enter `🙂🌸` into the Name field (U+1F642 and U+1F338 unicode characters)
5. enter `flowergirl@example.com` into the Email field
6. select `Normal` for the Type field
7. uncheck the Invite checkbox
8. click the Add button

Actual Result
-------------

A red "Server Error" message is displayed in the app UI.

Expected Result
---------------

User is created; user page is displayed with name containing emoji.

Workaround
----------

Create the user without any emoji characters in her name.

Links
-----

* possibly same issue?: https://todo.example.com/~arx10/procustodibus/123
* api server log files: https://pastebin.example.com/ABC123

Feature Requests

Please follow the same general format as above for feature requests. Use the Reproduction Steps section to describe how someone would invoke the feature, the Actual Result to describe what happens today, the Expected Result to describe what you’d like to happen, and the Workaround to describe what you have to do currently to work-around not having the feature.