edgi-govdata-archiving / archivers.space

🗄 Event data management app used at DataRescues
https://www.archivers.space/
GNU Affero General Public License v3.0
6 stars 3 forks source link

Add README instructions on setting up linter #61

Closed dcwalk closed 7 years ago

dcwalk commented 7 years ago

Per Code Walkthrough video comments 😄 , would be good to have details on setting up tools for consistent development documented in the README.

Linter with rules is in package.json (eslint, babel-eslint) ESlint 2015

ChaiBapchya commented 7 years ago

Do you want a documentation on How to setup ESLint? I would be happy to set it up myself and create a documentation of the same

dcwalk commented 7 years ago

@ChaiBapchya we are going to move our code base (and associated docs) to be publicly available ASAP and then your help will be definitely appreciated!

dcwalk commented 7 years ago

I spoke too soon! The code is open, documentation most welcome 👍

ChaiBapchya commented 7 years ago

Alright...working on it...Will setup ESLint and document the same

kmcculloch commented 7 years ago

@ChaiBapchya Thanks for the help! There's a bit of general info on linting over at https://github.com/edgi-govdata-archiving/overview/blob/master/protocol/linting.md, with some notes on archivers.space as an example. Feel free to copy & paste anything that would be helpful.

kmcculloch commented 7 years ago

Thanks again for the help @ChaiBapchya. I renamed your file, moved it to a "documentation" folder, and referenced it from our CONTRIBUTING.md file.