Enable automatic formatting of the guide #406
Conversation
bouweandela
force-pushed
the
automatic-formatting
branch
3 times, most recently
from
fbfb552 to
6230e3f
Compare
CONTRIBUTING.md
Outdated
| This guide is primarily written by the Research Software Engineers at the | ||
| Netherlands eScience Center. Contributions by anyone (also outside the Center) | ||
| are most welcome! |
There was a problem hiding this comment.
This style choice I have to kinda strongly disagree with :) In Markdown (also in LaTeX), I like to have each sentence on its own line so that git diff views don't get cluttered by meaningless line break shifts (as we see here). Can we disable this? I don't necessarily want to enforce my style choice, but at least let's discuss it separately before enabling here.
There was a problem hiding this comment.
I will not review the rest of the markdown files right now. I cannot easily browse changes this way, illustrating my point :P
There was a problem hiding this comment.
Having long or many sentences on a single line leads to unreadable diffs as well, so that's why I thought that limiting the line length might help. However, it only helps if you also start every new sentence on it's own line, because then the amount of words that shift will be limited to a single sentence which is still kind of awkward but not too bad. Unfortunately the formatter does not seem able to do that. I tried mdformat as well, but the results are similar (see #411).
Shall I just remove the line length limit for now? Or should we write in the contribution guidelines that people have to start every new sentence on a new line and I do it for the existing text in this PR?
There was a problem hiding this comment.
Let's remove the line length limit, indeed, and discuss the line style later. As I said, I don't really want to force this style upon people, I feel it overcomplicates the contribution process (I'm happier with ugly Markdown than with no Markdown :) ). But maybe I'm too cautious. I'd prefer to get a few more opinions, though. I will make a separate issue for this.
bouweandela
force-pushed
the
automatic-formatting
branch
from
6d9044c to
1f82414
Compare
✅ Deploy Preview for nlesc-guide-testing ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@egpbos This is ready for another round of review. |
There was a problem hiding this comment.
LGTM, thanks @bouweandela! One minor comment for consideration. I did not check all the markdown files in detail (did you?), so let's be alert for possible weirdness.
No, just looked at a couple of files |
Changes in this PR
Automatically format files using
prettierand pre-commit.Relevant changes are in d242da8, changes caused by automated formatting in 6230e3f. The broken links are not new in the pull pull request and in part caused by too much traffic coming from our CI.
Closes #119
Checklist
SIGNIFICANT changes / additions, e.g. new chapters
I checked whether the contribution fits in The Turing Way before considering contributing to this Guide.ALL contributions
python3 -m http.server 4000and confirmed they work correctly.docker run --init -it -v `pwd`:/docs lycheeverse/lychee /docs --config=docs/lychee.toml, at least for the files I changed.CITATION.cfffile.