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

/clean: new command of message about requesting code review from the community #627

Open
1 task done
nekosoffy opened this issue Nov 3, 2024 · 2 comments
Open
1 task done
Labels
Status: Needs Review This issue/PR needs an initial or additional review

Comments

@nekosoffy
Copy link

Checks

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this issue follows the command name: brief description of request format, e.g. /help: add optional @user parameter

Do you want to be assigned to this issue?

  • I would like to be assigned this issue to work on it

Description of the Feature Request

Every day a user pops a message in one of the help channels with the following content: "Hey, can anybody take a look at my code and see if I've implemented it in the most perfect way possible even though I'm still in Foundations?", or some variant like "Hey, can you guys check if my code is clean/performant/how can I shorten it/I feel it's messy/it's ugly" etc.

I think it could be useful to have a bot message with some general ideas like:

  • Great code comes from experience, so it can be very unproductive to pursue this ideal;
  • Don't compare your code to others (which might even have edited their solution long after they finished a project);
  • You don't need the community's blessing to approve your code. Students should have the autonomy to evaluate if they meet the project's criteria by themselves;
  • Performance is not a problem worth solving for small projects, so that's also a fruitless pursuit;

Something along those lines.

Acceptance Criteria

Tasks

Additional information

No response

@nekosoffy nekosoffy added the Status: Needs Review This issue/PR needs an initial or additional review label Nov 3, 2024
@nekosoffy nekosoffy changed the title New command of message about requesting code review from the community /review: new command of message about requesting code review from the community Nov 3, 2024
@nekosoffy nekosoffy changed the title /review: new command of message about requesting code review from the community /clean: new command of message about requesting code review from the community Nov 3, 2024
@MaoShizhong
Copy link
Contributor

Thanks for the suggestion, Soffy.

Personally, I feel like such a command may be a little too general in its scope if it were to cover the majority or the suggested use cases. Feels more like general FAQ command and I'd rather not have a command purely because of a commonly asked question, because some questions do benefit from a human response that's tailored to the question - a more personal touch. And this sort of question, while very common I agree, is something I just feel more "right" responding to in person than via a bot command, if that makes sense?

But that is 100% just my own opinion. Would like to hear other thoughts from @TheOdinProject/odin-bot and @TheOdinProject/moderators too.

@Mclilzee
Copy link
Member

Mclilzee commented Nov 4, 2024

I see where Mao coming from. We have been adding too many commands lately, and we should start pruning them a little, to not void TOP from that human interaction, that is one of the charms which make TOP unique.

I do see where this information might be helpful, maybe we can add them to one of the earliest lessons if it wasn't there to instruct people about their code cleanless / performance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review This issue/PR needs an initial or additional review
Projects
None yet
Development

No branches or pull requests

3 participants