-
Notifications
You must be signed in to change notification settings - Fork 314
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
Reformat README #8338
Reformat README #8338
Conversation
601cac2
to
a8578fe
Compare
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 ok to take it into use, but we should ASAP implement checks to enforce this (for already migrated files).
Like I mentioned in the core dev meeting, the problem is that there is no rule for that. There are two markdownlint plugins which we might use, but both of them don't seem to be actively maintained and I don't know how well they work: I could give it a try anyway. |
a8578fe
to
439b97c
Compare
Signed-off-by: Martin Nonnenmacher <[email protected]>
This allows to use the one sentence per line formatting to avoid that changing one sentence requires reformatting a whole paragraph. Signed-off-by: Martin Nonnenmacher <[email protected]>
Signed-off-by: Martin Nonnenmacher <[email protected]>
Signed-off-by: Martin Nonnenmacher <[email protected]>
439b97c
to
280029d
Compare
What's blocking to merge this @mnonnenmacher? |
I wasn't sure if you are stil ok with the merge in case it does not work to use one of the rules mentioned above, and I haven't found the time to test it yet. |
I'm still fine. Let's merge, and if the feel comfortable with the style, come up with automated checks and roll it out further. And if we are not fine, this change is small enough to revert (even manually). |
Please see the commit messages for details.