-
-
Notifications
You must be signed in to change notification settings - Fork 131
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
Minor readme improvments #442
Conversation
tkr-sh
commented
Nov 29, 2024
- Put the release process in it's own file
- Removed extra whitespaces in a rust code block
Hi @tkr-sh, thanks for your contribution! I like when code is formatted, so cleaning up examples is always good. Did you do that manually, or did you use a tool? Regarding the creation of another file, I don't really see the benefit. This is probably better to put this in the book, under a Contributing section, for example. |
I personally don't think that it's that a good idea to have that in the README, and here are some other projects that use a separate file:
and there are probably a lot more. But, if you don't agree, it's ok and I won't argue. Putting it in a book is also ok! Concerning the "cleaning up", I just noticed that there were spaces at the start of the line, so I just "manually" deleted them |
Ok that makes sense, let's keep it that way, and we will see in the future if we write a contributing guide or not :-)
Ok, I guess it was introduced by mistake in the past, but they look legit, so I trust the spacing must be consistent! Thanks for your contribution! |
* chore: move the release process to its own file * chore: remove extra whitespace in rust code block * chore: better with a title :) !
* Minor readme improvments (#442) * chore: move the release process to its own file * chore: remove extra whitespace in rust code block * chore: better with a title :) ! * chore(book): add simple calculator example (#439) * chore(book): add simple calculator example * fix(book): footnote * Apply suggestions from code review Co-authored-by: Jérome Eertmans <[email protected]> * Partially apply a suggestion from code review * fix(book): add clone instructions to the simple calculator example * chore(book): add the contributor info to the simple calculator example --------- Co-authored-by: ynn <[email protected]> Co-authored-by: Jérome Eertmans <[email protected]> * chore(release): bump version * chore(release): replace version in docs * chore(lint): apply Clippy and Rustfmt * chore(lint): allow needless lifetime --------- Co-authored-by: tk <[email protected]> Co-authored-by: ynn <[email protected]> Co-authored-by: ynn <[email protected]>