Contributing

Initial setup

First fork the Vue-Termynal repository then clone and build your fork locally. Run the following commands:

git clone https://github.com/your-username/vue-termynal.git
pnpm install

Development

Running your code

During development you can test your work in the playground folder. You can start the app inside it by running:

pnpm -F playground dev

Lint errors

The project uses ESlint, stylelint and prettier to ensure good code quality and consistent formatting. You can check your code with one simple command:

pnpm lint

I highly recommend installing the IDE extensions for these tools to see any errors during development.

After you finish

Documentation

Please check the docs (and if needed), document your changes and add new examples. The following command starts to the documentation site locally:

pnpm -F docs dev