Set up a mardown linter to make sure we have a consistent style

learn-neuroimaging / hitchhackers_guide_brain

A list of tutorials and other resources useful to learn open science and neuroimaging, EEG and MEG

https://learn-neuroimaging.github.io/hitchhackers_guide_brain/

Other

114 stars 42 forks source link

Set up a mardown linter to make sure we have a consistent style #55

Closed Remi-Gau closed 4 years ago

Remi-Gau commented 4 years ago

I was browsing through our files and I think we should set up a linter that makes sure that our markdown code is standardized so that we all "write" the same way.

I do use codacy on my repo : https://github.com/marketplace/codacy

But we could also set up remark the way it is used by the BIDS specification: https://github.com/remarkjs/remark-lint

Any other suggestions?

Any thoughts?

alexandreroutier commented 4 years ago

I never used these tools but they are quite standard in my opinion. It could be nice to have these kind of tools!

Once the Markdown files will be stabilized, a linter session would be a good opportunity.

alexandreroutier commented 4 years ago

Minimum thing to do:

Check that Mardown files are formatted automatically

Long terms:

Have a convention on how to write Markdown files?

Remi-Gau commented 4 years ago

@roopa-pai or @dr-xenia

Do you want to look into this?

Not right now. Just trying to see who to "assign" this to on the long term.

roopa-pai commented 4 years ago

I'd be happy to !

Remi-Gau commented 4 years ago

Awesome.

Do you want to have a look at this together first or would rather investigate this on your own first?

roopa-pai commented 4 years ago

Together would be ideal, please let me know whenever you have time!

Remi-Gau commented 4 years ago

Together would be ideal, please let me know whenever you have time!

One afternoon in the coming week?