Discussing Ideas and Reporting Issues

General Rules

• The repository issue tracker is used for feature ideas and bug reports.
• Before creating a new issue, make sure a similar one does not already exist.
• Each issue must describe exactly one idea or one problem.

Feature Ideas and Proposals

Issue requirements:

• A short and unambiguous title.
• A description of the problem the proposed functionality should solve.
• The motivation for the change.
• The expected behavior of the system after the feature is implemented.
• Constraints and assumptions, if any.

Bug Reports

Issue requirements:

• A short and unambiguous title.
• A clear description of the problem.
• Expected behavior.
• Actual behavior.
• Steps to reproduce the issue.
• Environment details (Python version, OS, configuration in use).
• Relevant log excerpts or stack traces, if available.

Working with Issues

• Before starting work on a task, make sure the issue is still relevant.
• If you plan to work on an issue, explicitly state this in a comment.
• Pull requests are linked to issues via references in the pull request description.
• Issues are closed after the corresponding pull request is merged or at the maintainers discretion.