solid-contrib / information

Old location of information now available on site
https://solidproject.org
Other
134 stars 48 forks source link

Add markdown linting and enforce CI checks #153

Closed raulrpearson closed 5 years ago

raulrpearson commented 5 years ago

I've noticed that Travis CI checks are failing for PRs, mainly because there's a bunch of broken links throughout the repository (example).

I cloned the repository locally to work on a PR to fix the broken links but also noticed that the Markdown source could do with some linting and reformatting.

I'm opening this issue so that we can discuss if we'd like to put in place pre-commit hooks and pre-merge rules that prevent us from adding content that breaks CI checks. Taking into account that we probably want to retain the capability of using GitHub web interface to submit commits, here are some ideas:

I'm not entirely sure if all these are possible or how to implement, but I'm happy to look into it.

Mitzi-Laszlo commented 5 years ago

Great ideas, would be good to know what it would mean to implement these ideas to be able to comment.