Skip to content

adding issue template.#18

Merged
jvachier merged 1 commit intomainfrom
jv/issue_template
May 12, 2025
Merged

adding issue template.#18
jvachier merged 1 commit intomainfrom
jv/issue_template

Conversation

@jvachier
Copy link
Copy Markdown
Owner

@jvachier jvachier commented May 12, 2025

Describe your changes

Provide a clear and concise description of the changes made in this pull request. Include any relevant context or background information.

  • What is the purpose of this pull request?
  • What problem does it solve?
  • What functionality does it add or improve?

Issue ticket number and link

Type of Change

Check the type of change your pull request introduces:

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (code improvements without changing functionality)

Checklist before requesting a review

Before submitting your pull request, ensure the following:

  • I have performed a self-review of my code.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added or updated relevant documentation (if applicable).
  • My changes do not introduce any new warnings or errors.
  • I have checked for security vulnerabilities in the code.
  • I have ensured backward compatibility (if applicable).

@jvachier jvachier self-assigned this May 12, 2025
@jvachier jvachier requested a review from Copilot May 12, 2025 18:55
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds a new issue template to guide users in reporting issues and suggesting feature requests or documentation updates. Key changes include:

  • Addition of a structured template outlining issue types and detailed reporting sections.
  • Inclusion of sections for steps to reproduce, expected vs actual behavior, and environment information.

<!-- Describe the issue in detail. Include what the problem is, where it occurs, and any relevant context. -->

## Steps to Reproduce
<!-- For bugs, provide a step-by-step guide to reproduce the issue. Skip this section for feature requests. -->
Copy link

Copilot AI May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider adding an example step under 'Steps to Reproduce' to provide clearer guidance for users reporting issues.

Suggested change
<!-- For bugs, provide a step-by-step guide to reproduce the issue. Skip this section for feature requests. -->
<!-- For bugs, provide a step-by-step guide to reproduce the issue. Skip this section for feature requests. -->
<!-- Example: -->
<!-- 1. Open the application. -->
<!-- 2. Navigate to the 'Settings' page. -->
<!-- 3. Click on 'Save' without making any changes. -->

Copilot uses AI. Check for mistakes.
@jvachier jvachier merged commit 4ca06be into main May 12, 2025
@jvachier jvachier deleted the jv/issue_template branch May 12, 2025 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants