Document Development Process
roblarsen opened this issue · 2 comments
@vltansky Can you write up how to develop this? I'm going to try to enlist some help testing it since I just ran into some issues testing it myself and if people decide they want to help fix stuff I'd like to be able to point them in the right direction. We can add a new section to the Readme.
Not sure what to write.
Generally there are two main files. cli.js and tests/test.js.
And index.js that just imports and run cli.js.
If you mean a section like 'how to start contributing'. We didn't use any builds/typescript, prettier runs automatically on commit (via husky package).
So its just git clone, npm install, and npm link (works same as npm install -g). npx and npm init commands will execute the local repo instead of downloading from npmregistry.
Would you want me to make PR to README with these instructions? Or you meant something else?
How do you set up your environment so that you can develop locally. Simply that. Make a PR with the steps to be able to run and test this locally and I'll help polish it if anything is unclear (I'll end up testing it myself)