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

Readability of diff for Terms of Use #1028

Open
rikhuijzer opened this issue Aug 10, 2020 · 0 comments
Open

Readability of diff for Terms of Use #1028

rikhuijzer opened this issue Aug 10, 2020 · 0 comments

Comments

@rikhuijzer
Copy link

The Terms of Use is written in Markdown. When using Markdown with Git, many people place each new line of text on a new line. For example, the README of Images.jl or the README of haskell-language-server. These newlines are convenient for people who use more advanced text editors, like Vim and Emacs, to quickly manipulate sentences. More importantly, they improve the readability of the diff.

Just now, I received a mail to inform me about the updated Terms of Use for COS websites and services. This mail contains a link to the diff of the Terms of Use. Specifically, https://github.com/CenterForOpenScience/cos.io/pull/1025/files. One of the changed lines went from 458 words to 513 words. The exact change is non-trivial to detect.

With this issue, I would like to request for the next Terms of Use change to be placing new sentences on new lines if possible, so that the changes can easily be inspected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
1 participant