|
| 1 | +name: 🐛 Bug Report |
| 2 | +description: Submit a bug report to help us improve |
| 3 | +labels: [bug, triage] |
| 4 | +body: |
| 5 | + - type: markdown |
| 6 | + attributes: |
| 7 | + value: | |
| 8 | + ## Please help us help you! |
| 9 | +
|
| 10 | + Before filing your issue, ask yourself: |
| 11 | +
|
| 12 | + - Is this clearly a Pact Python bug? |
| 13 | + - Do I have basic ideas about where it goes wrong? |
| 14 | + - Could it be because of my own mistakes? |
| 15 | +
|
| 16 | + **The GitHub issue tracker is not a support forum**. If you are not sure whether it could be your mistakes, ask on [Slack](https://slack.pact.io). |
| 17 | +
|
| 18 | + Make the bug obvious. Ideally, we should be able to understand it without running any code. |
| 19 | +
|
| 20 | + Bugs are fixed faster if you include: |
| 21 | + - A reproduction repository to replicate the issue |
| 22 | + - Pact files |
| 23 | + - Logs |
| 24 | +
|
| 25 | + - type: checkboxes |
| 26 | + attributes: |
| 27 | + label: Have you read the Contributing Guidelines on issues? |
| 28 | + options: |
| 29 | + - label: I have read the [Contributing Guidelines on issues](https://github.com/pact-foundation/pact-python/main/CONTRIBUTING.md#issues). |
| 30 | + required: true |
| 31 | + |
| 32 | + - type: checkboxes |
| 33 | + attributes: |
| 34 | + label: Prerequisites |
| 35 | + description: Please check the following items before creating a issue. This way we know you've done these steps first. |
| 36 | + options: |
| 37 | + - label: I'm using the latest version of `pact-python`. |
| 38 | + required: true |
| 39 | + - label: I have read the console error message carefully (if applicable). |
| 40 | + |
| 41 | + - type: textarea |
| 42 | + attributes: |
| 43 | + label: Description |
| 44 | + description: A clear and concise description of what the bug is. |
| 45 | + validations: |
| 46 | + required: true |
| 47 | + |
| 48 | + - type: input |
| 49 | + attributes: |
| 50 | + label: Reproducible demo |
| 51 | + description: | |
| 52 | + Paste the link to an example repo if possible, and exact instructions to reproduce the issue. |
| 53 | +
|
| 54 | + > **What happens if you skip this step?** Someone will read your bug report, and maybe will be able to help you, but it's unlikely that it will get much attention from the team. Eventually, the issue will likely get closed in favor of issues that have reproducible demos. |
| 55 | +
|
| 56 | + Please remember that: |
| 57 | +
|
| 58 | + - Issues without reproducible demos have a very low priority. |
| 59 | + - The person fixing the bug would have to do that anyway. Please be respectful of their time. |
| 60 | + - You might figure out the issues yourself as you work on extracting it. |
| 61 | +
|
| 62 | + Thanks for helping us help you! |
| 63 | +
|
| 64 | + - type: textarea |
| 65 | + attributes: |
| 66 | + label: Steps to reproduce |
| 67 | + description: Write down the steps to reproduce the bug. You should start with a fresh installation, or your git repository linked above. |
| 68 | + placeholder: | |
| 69 | + 1. Step 1... |
| 70 | + 2. Step 2... |
| 71 | + 3. Step 3... |
| 72 | + validations: |
| 73 | + required: true |
| 74 | + |
| 75 | + - type: textarea |
| 76 | + attributes: |
| 77 | + label: Expected behavior |
| 78 | + description: How did you expect your project to behave? It's fine if you're not sure your understanding is correct. Write down what you thought would happen. |
| 79 | + placeholder: Write what you thought would happen. |
| 80 | + validations: |
| 81 | + required: true |
| 82 | + |
| 83 | + - type: textarea |
| 84 | + attributes: |
| 85 | + label: Actual behavior |
| 86 | + description: | |
| 87 | + Did something go wrong? Is something broken, or not behaving as you expected? Describe this section in detail. Don't only say "it doesn't work"! Please submit exhaustive and complete log messages, not just the final error message. |
| 88 | +
|
| 89 | + > Please read error messages carefully: it often tells you exactly what you are doing wrong. |
| 90 | +
|
| 91 | + If the logs are too long, you can paste them in a [gist](https://gist.github.com/) and link it here. |
| 92 | + placeholder: | |
| 93 | + Write what happened. Add full console log messages. |
| 94 | + validations: |
| 95 | + required: true |
| 96 | + |
| 97 | + - type: textarea |
| 98 | + attributes: |
| 99 | + label: Your environment |
| 100 | + description: Include as many relevant details about the environment you experienced the bug in. |
| 101 | + value: | |
| 102 | + - Public source code: |
| 103 | + - Pact Python version used: `pip list | grep pact` |
| 104 | + - Operating system and version (e.g. Ubuntu 20.04.2 LTS, macOS Ventura): |
| 105 | +
|
| 106 | + - type: checkboxes |
| 107 | + attributes: |
| 108 | + label: Self-service |
| 109 | + description: | |
| 110 | + If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it. |
| 111 | +
|
| 112 | + If you do check this box, please send a pull request. If circumstances change and you can't work on it anymore, let us know and we can re-assign it. |
| 113 | + options: |
| 114 | + - label: I'd be willing to fix this bug myself. |
0 commit comments