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 label for improvements to working code that are technically unneeded #2

Open
joshuadavidthomas opened this issue May 8, 2024 · 1 comment

Comments

@joshuadavidthomas
Copy link
Member

Sometimes I have improvements or ideas about improvements to existing code that can be considered "mental masturbation" -- the existing code works and accomplishes exactly what it needs to do, but I cannot shake the idea that there is a better, cleaner (groan 🙄) way to do things.

I still think it's useful to capture these as sometimes it's an actual good improvement over what's there now, but I try to be skeptical of refactoring just for the sake of refactoring. Unless something is SO egregious that it's impossible to work with, it's usually better to leave it be.

Asked 🤖 for some suggestions for the label and description, since I can't use what first comes to my mind (it's lewd and not exactly useful in a professional setting 😅), and there's some OK ones in here. Need to think on it.

- name: 🌟 refine
  color: "6f42c1"
  description: "Improvements to the elegance or efficiency of existing code that already functions correctly."

- name: 💎 polish
  color: "0052cc"
  description: "Enhancements to streamline or beautify existing solutions without altering functionality."

- name: 🛠️ tweak
  color: "fbca04"
  description: "Minor but meaningful enhancements to tighten up working code."

- name: 🧐 scrutinize
  color: "b07000"
  description: "Revisiting and critiquing functional code to enhance clarity or performance."

- name: 🧐 prettify
  color: "8a2be2"
  description: "Sprucing up code that works—because looks matter too."

- name: 🤨 nitpick
  color: "c5b0d5"
  description: "Tidying up the little things in code that no one else might notice."

- name: 🙄 overthink
  color: "f0ad4e"
  description: "Revising code that’s fine, just because we can do better."

- name: 🧐 finesse
  color: "2c3e50"
  description: "Fine-tuning good code into great code with a touch of class."

- name: 🙃 embellish
  color: "ff6347"
  description: "Adding a dash of flair to functional code for sheer enjoyment."

- name: 🛠️ bike-shedding
  color: "0075ca"
  description: "Focusing on trivial details rather than the more significant aspects of the project, inspired by Parkinson's Law of Triviality."

- name: 🌟 gold-plating
  color: "ffd700"
  description: "Adding unnecessary features or enhancements to a solution, thus over-complicating what was sufficient."
@joshuadavidthomas
Copy link
Member Author

Bike shedding a label about bike shedding 🤣

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant