ort icon indicating copy to clipboard operation
ort copied to clipboard

Reformat README

Open mnonnenmacher opened this issue 1 year ago • 1 comments

Please see the commit messages for details.

mnonnenmacher avatar Feb 25 '24 15:02 mnonnenmacher

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: https://www.npmjs.com/package/markdownlint-rule-max-one-sentence-per-line https://www.npmjs.com/package/sentences-per-line

I could give it a try anyway.

mnonnenmacher avatar Feb 27 '24 14:02 mnonnenmacher

What's blocking to merge this @mnonnenmacher?

sschuberth avatar Mar 07 '24 08:03 sschuberth

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.

mnonnenmacher avatar Mar 07 '24 12:03 mnonnenmacher

I wasn't sure if you are stil ok with the merge

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).

sschuberth avatar Mar 07 '24 13:03 sschuberth