waltsims/k-wave-python

Feature Request: Add a "Code Enhancement" Issue Template

Closed this issue · 0 comments

Feature Request: Add a "Code Enhancement" Issue Template

Summary

I propose adding a new issue template titled "Code Enhancement" to better categorize improvements aimed at code quality, readability, and maintainability.

Problem

Currently, the repository's issue templates do not specifically address non-functional improvements.

Proposed Issue Template Details

Title: Code Enhancement
About: Suggest improvements for code readability, refactoring, and other non-functional enhancements.
Template Content:

  • Description of the Enhancement: What part of the codebase could be improved and why?
  • Potential Benefits: How will these changes benefit the project?
  • Suggested Changes: Describe the proposed code changes in detail.
  • Additional Context: Any other information or screenshots that might help understand the impact of these changes.

Impact

This template will encourage more developers to contribute to the internal quality of the code, leading to a healthier, more maintainable codebase.

Alternatives Considered

Alternatively, contributors could continue using the "Feature" template for such improvements, but this might dilute the focus on new functionality and lead to categorization issues.