Update developer docs and add pre-commit webhook

LibraryOfCongress / concordia

Crowdsourcing platform for full text transcription and tagging. https://crowd.loc.gov

https://labs.loc.gov/

Other

154 stars 31 forks source link

Update developer docs and add pre-commit webhook #541

Closed rstorey closed 3 years ago

rstorey commented 5 years ago

Some of the developer guide needs to be updated accurate steps and information on how to install and use pre-commit.

It would also be nice if recommended VS Code plugins and settings could be documented in our dev guide as well.

jkueloc commented 3 years ago

@rstory @acdha @rabiloc - Do you have specific VS Code plugins and settings that you would like to recommend in addition to the Python extension.

acdha commented 3 years ago

Most of them follow the same tools we're using in our Pre-Commit configuration. The most important one is the Editor Config extension, which causes VSCode to use the .editorconfig settings in the repo, and the Prettier one is handy for ensuring that you don't have to wait for pre-commit to run to reformat JavaScript, CSS, etc.

amazonwebservices.aws-toolkit-vscode
dbaeumer.vscode-eslint
shinnn.stylelint
EditorConfig.EditorConfig
esbenp.prettier-vscode
mrmlnc.vscode-scss