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

Make Readme Great Again #422

Open
evgenydmitriev opened this issue May 5, 2024 · 0 comments
Open

Make Readme Great Again #422

evgenydmitriev opened this issue May 5, 2024 · 0 comments

Comments

@evgenydmitriev
Copy link
Contributor

We have a number of internal tools to keep our repository alive and tidy. However, the readme has been neglected and needs to be refreshed.

To participate in the challenge, submit a pull request that refactors the existing readme file to improve its readability and make sure it's up-to-date with the current state of the tools. Our target audience are newcomers with minimal tech skills, so focus on the simplicity and ease of understanding. Feel free to use Markdown and GitHub's advanced formatting to make it even more beautiful and entertaining (emojis and GIFs are welcome). When done, request a PR review from this issue assignee. Expanding the pull request description with your methodology can help us better understand your reasoning and evaluate your submission faster.

Anyone can participate in this challenge. You don't need anyone's approval to try! See more details on the Challenge Program and check out the success stories of the challenge winners.

Looking forward to your submissions!

💡Hint You don't need to understand our tools or know much about software development to generate great documentation using the latest-gen LLMs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants