CosmoStat / wf-psf

Data-driven wavefront-based PSF modelling framework.
MIT License
19 stars 9 forks source link

Add templates for different types of issues #109

Closed nadamoukaddem closed 8 months ago

nadamoukaddem commented 8 months ago

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.

jeipollack commented 8 months ago

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! 🛠️

nadamoukaddem commented 8 months ago

All requested changes made.