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

Explore textlint #387

Open
rgaiacs opened this issue Jan 24, 2019 · 7 comments
Open

Explore textlint #387

rgaiacs opened this issue Jan 24, 2019 · 7 comments

Comments

@rgaiacs
Copy link
Contributor

rgaiacs commented Jan 24, 2019

textlint is linting tool for text and markdown. It sounds interesting to add to our pipeline.

@brownsarahm
Copy link
Contributor

what is linting?

@rgaiacs
Copy link
Contributor Author

rgaiacs commented Jan 24, 2019

@brownsarahm you can think of a spell check for code.

@gdevenyi
Copy link
Contributor

It would be really nice if we could get something like this integrated into a Travis/CircleCI on the lessons, so that PRs are checked for markdownness

@maxim-belkin
Copy link
Contributor

We're using Kramdown.
Lessons are checked with make lesson-check for some common mistakes and make site (jekyll build). If something is not right - it fails and reports an error. I think we should probably start by asking maintainers to try it and give feedback. I'll try it myself :)

@maxim-belkin
Copy link
Contributor

I wish we had @maintainers

@gdevenyi
Copy link
Contributor

Thanks @maxim-belkin I'm aware of make lesson-check, but that has be done manually with a local copy. I would like to see a CI system do this automatically for PRs rather than manually.

@maxim-belkin
Copy link
Contributor

This is being done automatically now: there is travis.yml in bin/boilerplate that you can use in your repository. We're using Travis in https://github.com/swcarpentry/python-novice-inflammation/pulls

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

No branches or pull requests

4 participants