-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
A better and user friendly read me! #18062
base: main
Are you sure you want to change the base?
Conversation
I've revamped the README to make it more engaging and user-friendly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm 100% in favor of simplifying our readme like you did, but I'm personally averse to making it more "playful". I'd prefer if it was factual and direct. VS Code has a nice readme: https://github.com/microsoft/vscode
(Also, let's please not use LLMs for generating our main readme.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with lhecker's comments. There's also a decent amount of content that was removed from the "Developer Guidance" section, that was removed in favor of going to the contributor's guide. I don't disagree with that, but let's make sure to actually move that content to it's new home 😉
@zadjii-msft wrote :-
Thank you for your feedback. The requested changes will be made soon! |
This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within 7 days of this comment. |
I've revamped the README to make it more engaging and user-friendly. Here are the key improvements:
Best Regards,
Thank you -
[email protected]