Update readme to go to .org.

master
josiah 2 years ago
parent c5b9d676b8
commit f8da988313

@ -0,0 +1,28 @@
* quantified josiah
Project that houses all my scripts and automation for pulling in data from external-to-me projects.
** Development
Make sure this is run inside a git repo.
#+NAME: Install prereqs
#+begin_src shell
pipenv shell
pipenv install -d isort mypy pylint pre-commit
#+NAME:Configure pre-commit
#+begin_src shell
pre-commit install
pre-commit autoupdate
#+end_src
Since this is the first time running any linters in your project, you probably want to run it against your whole project:
~pre-commit run --all-files~
Going forward, pre-commit and its hooks will be run ahead of every commit you make.
*** Common issues
1. You really need to be inside a git repo or pre-commit will not work.
2. If you modify `pyproject.toml` make sure your syntax is correct; many linters will error in arcane ways due to an improperly titled section.
Loading…
Cancel
Save