Getting Started
Contributing
We can never thank you enough for your contributions. ❤️
Read more about Nuxt contribution guide here.
How to contribute?
- Clone nuxt-security repository
- Install dependencies using
yarn
- Run
yarn dev:prepare
to generate type stubs.
Nuxt Security
- Use
yarn dev
to start the playground in development mode. - Apply your changes
- Add tests into the test/ directory and run
yarn test
to make sure they pass. - Check the code style with
yarn lint
- Before creating a PR, make sure to run
yarn build
and that no errors are reported.
Documentation
- Use
yarn dev:docs
to start the documentation in development mode. - Open http://localhost:3000 to view it in the browser.
- Update the content of the documentation in the docs/content/ directory.