Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add templates for different types of issues #109

Merged
merged 20 commits into from
Jan 8, 2024
Merged

Conversation

nadamoukaddem
Copy link
Contributor

solves #106
Implement ISSUE_TEMPLATE in the .github directory and configure all templates for different reported issue types, following the examples from the shapepipe repository.

@nadamoukaddem nadamoukaddem self-assigned this Dec 20, 2023
@nadamoukaddem nadamoukaddem linked an issue Dec 20, 2023 that may be closed by this pull request
@jeipollack
Copy link
Contributor

I have another request. Could you add a refactoring-request.md template?


name: Code Refactoring
about: Request for refactoring or improving the codebase
title: "[REFACTOR] Brief Description of Refactoring/Improvement"
labels: refactor, enhancement
assignees: ''


Description of Refactoring/Improvement
Provide a clear and concise description of the codebase elements you'd like to refactor or improve.

Goals and Objectives
Outline the goals and objectives of the refactoring or improvement effort.

Current Code Behavior
Describe the current behavior of the code and any issues or challenges it presents.

Proposed Changes
Specify the changes you propose for the refactoring or improvement. Include code snippets if applicable.

Expected Benefits
Explain the expected benefits of the proposed changes, such as improved performance, readability, or maintainability.

Dependencies
List any dependencies or considerations related to other parts of the codebase.

Testing Plan
Provide a plan for testing the refactored or improved code.

Additional Context
Include any other relevant context or information related to the refactoring or improvement.

Impact Assessment
Briefly assess the impact of these changes on the overall codebase and project.

Next Steps
Outline the next steps or actions that need to be taken for the refactoring or improvement.

Thank you for starting this request to refactor or improve the code. We will review it and collaborate to enhance the codebase together! 🛠️

Copy link
Contributor

@jeipollack jeipollack left a comment

Choose a reason for hiding this comment

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

Hi Nada, thanks for working on this task. I made suggestions to improve the templates.

.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature_request.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/help-.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/installation-issue.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/package-management.md Outdated Show resolved Hide resolved
@nadamoukaddem
Copy link
Contributor Author

All requested changes made.

Copy link
Contributor

@jeipollack jeipollack left a comment

Choose a reason for hiding this comment

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

Thanks a lot. It all looks good.

@jeipollack jeipollack merged commit 9f068a4 into develop Jan 8, 2024
1 check passed
@jeipollack jeipollack deleted the add_issues_templates branch January 8, 2024 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make templates for different types of issue reporting
2 participants