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

Suggest Default Prompt for Refactoring Workflow #337

Open
runjinz opened this issue Apr 16, 2024 · 0 comments
Open

Suggest Default Prompt for Refactoring Workflow #337

runjinz opened this issue Apr 16, 2024 · 0 comments
Assignees
Labels
enhancement P1 Important but not that urgent

Comments

@runjinz
Copy link

runjinz commented Apr 16, 2024

Problem Description

During the refactoring workflow process, it appears that users are not provided with a default suggestion or prompt. This lack of guidance might lead to confusion or inefficiency as there are generally accepted best practices in refactoring that could be beneficial to follow. Adhering to the principle of 'Don't Make Me Think' by Steve Krug, it would enhance the user experience significantly if a default prompt were provided. Such a prompt could serve as a gentle nudge towards those best practices or as a starting point that users could then modify or override according to their specific needs.

Suggested Enhancement

I propose that we introduce a default prompt or suggestion during the initial stage of the refactoring workflow. This prompt should reflect commonly accepted best practices in refactoring. The idea is not to constrain the user but to provide a foundation which they can either accept or build upon. This approach respects the users' expertise and time by guiding them towards effective practices while still allowing for full customization.

Benefits

  • Reduces the initial barrier for users unfamiliar with best practices in refactoring.
  • Speeds up the refactoring process by providing a starting point.
  • Ensures that the refactoring workflow begins with a consideration of best practices, potentially improving code quality.

Implementation Considerations

  • Determine what the default prompt should be based on community standards and best practices.
  • Implement the prompt in a way that is easily overridden by user input to ensure flexibility.
  • Consider adding a brief explanatory tooltip or documentation link alongside the default prompt for users who wish to learn more about the rationale behind the suggestion.

This enhancement could make the refactoring process more intuitive and efficient, especially for those who might not be as familiar with the best practices involved. Looking forward to hearing the team's thoughts on this suggestion.

@runjinz runjinz added P1 Important but not that urgent enhancement labels Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement P1 Important but not that urgent
Projects
None yet
Development

No branches or pull requests

2 participants