📝 Update Issue and PR templates (#646)

Author: burgholzer

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,45 +1,54 @@
-name: 🐛 Bug report
-description: Something is not working correctly.
-title: "🐛 <title>"
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
+name: 🐛 Bug Report
+description: Report a problem or unexpected behavior
+title: "🐛 <brief description of the issue>"
 body:
   - type: markdown
     attributes:
       value: >-
-        **Thank you for wanting to report a bug for this project!**
-
-        ⚠
-        Verify first that your issue is not [already reported on GitHub](https://github.com/cda-tum/mqt-qmap/search?q=is%3Aissue&type=issues).
+        **Thanks for taking the time to report an issue!**
 
-        If you have general questions, please consider [starting a discussion](https://github.com/cda-tum/mqt-qmap/discussions).
+        ⚠ Before submitting:
+        1. Search [existing issues](https://github.com/munich-quantum-toolkit/qmap/search?q=is%3Aissue&type=issues) to avoid duplicates
+        2. For questions or discussions, please use our [discussions forum](https://github.com/munich-quantum-toolkit/qmap/discussions)
   - type: textarea
     attributes:
-      label: Environment information
-      description: >-
-        Please provide information about your environment. For example, OS, C++ compiler, mqt.qmap version etc.
+      label: System Information
+      description: Please provide details about your environment
       placeholder: |
-        - OS:
-        - C++ compiler:
-        - mqt.core version:
-        - Additional environment information:
+        - Operating System (including version):
+        - MQT QMAP version:
+        - Python/C++ compiler version (if applicable):
+        - Any relevant dependencies and their versions:
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Description
-      description: A clear and concise description of what the bug is.
+      label: Bug Description
+      description: Provide a clear and detailed explanation of the issue you're experiencing.
+      placeholder: |
+        What happened?
+        What did you expect to happen instead?
+        Include any error messages or unexpected behavior you observed.
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Expected behavior
-      description: A clear and concise description of what you expected to happen.
-  - type: textarea
-    attributes:
-      label: How to Reproduce
-      description: Please provide steps to reproduce this bug.
+      label: Steps to Reproduce
+      description: Provide specific steps to reproduce this issue
       placeholder: |
-        1. Get package from '...'
-        2. Then run '...'
-        3. An error occurs.
+        1. Set up environment with '...'
+        2. Configure workflow using '...'
+        3. Execute command '...'
+        4. Observe error/issue: '...'
+
+        Include any relevant code snippets, workflow configurations, or input files that help demonstrate the problem.
     validations:
       required: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,32 +1,44 @@
+# Copyright (c) 2023 - 2025 Chair for Design Automation, TUM
+# Copyright (c) 2025 Munich Quantum Software Company GmbH
+# All rights reserved.
+#
+# SPDX-License-Identifier: MIT
+#
+# Licensed under the MIT License
+
 name: ✨ Feature request
-description: Suggest an idea
+description: Suggest a new feature or improvement
 title: "✨ <title>"
 body:
   - type: markdown
     attributes:
       value: >
-        **Thank you for wanting to suggest a feature for this project!**
+        **Thanks for helping improve this project by suggesting a feature!**
 
-        ⚠
-        Verify first that your idea is not [already requested on GitHub](https://github.com/cda-tum/qmap/search?q=is%3Aissue&type=issues).
+        ⚠ Before submitting:
+        - Search [existing feature requests](https://github.com/munich-quantum-toolkit/qmap/search?q=is%3Aissue&type=issues) to avoid duplicates
+        - One feature per issue helps us track and implement ideas effectively
 
   - type: textarea
     attributes:
-      label: What's the problem this feature will solve?
+      label: Problem Statement
       description: >-
-        What are you trying to do, that you are unable to achieve as it currently stands?
+        Describe the problem you're facing and why it needs to be solved. What limitations are you encountering?
       placeholder: >-
-        I'm trying to do X and I'm missing feature Y for this to be
-        easily achievable.
+        Currently, when I try to [action/task], I'm unable to [blockers/limitations].
+        This creates problems because [impact/consequences].
     validations:
       required: true
 
   - type: textarea
     attributes:
-      label: Describe the solution you'd like
+      label: Proposed Solution
       description: >
-        Clear and concise description of what you want to happen.
+        Describe your ideal solution. What would the feature look like? How would it work?
       placeholder: >-
-        When I do X, I want to achieve Y in a situation when Z.
+        I'd like to see [feature/change] that would:
+        - [benefit 1]
+        - [benefit 2]
+        - [example usage/scenario]
     validations:
       required: true

.github/pull_request_template.md

@@ -1,16 +1,22 @@
 ## Description
 
-Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+Please include a summary of the change and, if applicable, which issue is fixed.
+Please also include relevant motivation and context.
+List any dependencies that are required for this change.
 
-Fixes # (issue)
+Fixes #(issue) <!--- Replace `(issue)` with the issue number fixed by this pull request. If this PR does not fix an issue, please remove this line. -->
 
 ## Checklist:
 
 <!---
 This checklist serves as a reminder of a couple of things that ensure your pull request will be merged swiftly.
 -->
 
-- [ ] The pull request only contains commits that are related to it.
-- [ ] I have added appropriate tests and documentation.
-- [ ] I have made sure that all CI jobs on GitHub pass.
-- [ ] The pull request introduces no new warnings and follows the project's style guidelines.
+- [ ] The pull request only contains commits that are focused and relevant to this change.
+- [ ] I have added appropriate tests that cover the new/changed functionality.
+- [ ] I have updated the documentation to reflect these changes.
+- [ ] I have added entries to the changelog for any noteworthy additions, changes, fixes or removals.
+- [ ] I have added migration instructions to the upgrade guide (if needed).
+- [ ] The changes follow the project's style guidelines and introduce no new warnings.
+- [ ] The changes are fully tested and pass the CI checks.
+- [ ] I have reviewed my own code changes.