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

Update readme #3392

Open
RSDuff opened this issue Nov 5, 2024 · 0 comments
Open

Update readme #3392

RSDuff opened this issue Nov 5, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@RSDuff
Copy link

RSDuff commented Nov 5, 2024

Documentation link

https://github.com/TandoorRecipes/recipes/blob/develop/README.md

Affected section

Other (please state below)

Other

the readme.txt

Issue description

Hello!

I just wanted to make a very simple suggestion for the readme.txt. Overall I think it is absolutely fantastic! However in one section called "Contributing" I think that the entire line "Contributions are welcome but please read this BEFORE contributing anything" Should have the entire line bolded, or at a higher position in the readme maybe making it the first section, or by increasing the text size for it.

For example:
Contributions are welcome but please read this BEFORE contributing anything

My reasoning for this change is because while going through your document I actually missed this section until I read through it a second time, to make it better for newer people to know what they need to do to if they want to contribute.

I would also suggest adding a section showing what you're looking for currently from contributors as well.

@RSDuff RSDuff added the documentation Improvements or additions to documentation label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant