Opening an Issue

Bug Report

Since you landed on this part of the documentation, we want to first of all say thank you! 💜 Bug reports are essential to improving pruna, and you are actively helping us identify and fix issues more efficiently. We appreciate your effort in making pruna better for everyone!

A well-structured report allows us to understand and reproduce the problem quickly, leading to faster resolutions. Before submitting a bug report, you should consider the following points:

  • Check for duplicates – Ensure the issue hasn’t already been reported by searching existing issues.

  • Stay on topic – Bug reports should be specific to the pruna package code. For general questions about integrating pruna or errors when integrating pruna into your codebase, consider joining the help-desk channel on our Discord.

  • Provide a reproducible example – Include a minimal code snippet that triggers the issue. If it’s lengthy, link to a GitHub Gist.

  • Attach a complete traceback – A full error traceback helps diagnose the problem faster.

  • Format correctly – Use code blocks for both the code snippet and traceback for readability.

  • Follow the template – The issue template guides you on what information to include.

When opening a bug report on GitHub, you will encounter the following template to help you structure your issue. Make sure to fill out all sections applicable to your issue so that we can help you out as fast as possible:

 1## Describe the bug
 2<!-- A clear and concise description of what the bug is. -->
 3
 4## What I did
 5
 6```
 7Paste the command(s) you ran and the output.
 8If there was a crash, please include the traceback here.
 9```
10
11## Expected behavior
12<!-- A clear and concise description of what you expected to happen. -->
13
14## Screenshots
15<!-- If applicable, add screenshots to help explain your problem. -->
16
17## Environment
18 - pruna version: 
19 - python version: 
20 - Operating System: 
21
22## Additional context
23<!-- Add any other context about the problem here. -->

Feature Request

We appreciate your interest in improving pruna! Feature requests help shape the project, and we welcome ideas that align with our mission.

Before submitting your feature request, consider the following points to ensure your request is clear and actionable:

  • Check for existing requests – Search the issue tracker to avoid duplicates.

  • Determine relevance – Ensure the feature aligns with pruna’s scope and objectives.

  • Be specific - Explain why this feature is needed and how it benefits users. If you have any ideas on how it might be implemented, feel free to share them.

When opening a feature request on GitHub, you will encounter the following template to help you structure your suggestion. Make sure to fill out all sections applicable to your feature request so that we can integrate it in Pruna as fast as possible:

1## Is your feature request related to a problem? Please describe.
2<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
3
4## Describe the solution you'd like
5<!-- A clear and concise description of what you want to happen. -->
6
7## Additional context
8<!-- Add any other context or screenshots about the feature request here. -->