Hey! Thanks for your interest in improving qnm! There are plenty of ways you can help!
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Please provide us with an issue in case you've found a bug, want a new feature, have an awesome idea, or there is something you want to discuss.
Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Fork the repo, clone, install dependencies and run the tests:
git clone [email protected]:<username>/qnm.git
cd qnm
yarn
yarn build
yarn test
To test the qnm command, run the following from the project root:
npm linkNow you should be able to run qnm from anywhare, and it will be linked to your local project.
In order to run the tests in watch mode (jest), run the following command:
yarn test:watch
In order to run the linter (eslint), run the following command:
yarn lint
- The linter will run before commit on staged files, using husky and lint-stage.