Contributing

We appreciate your interest in contributing to Pixel 2 for Vue 3. Please find below a set of guidelines designed to facilitate your contribution process.

Setup the Project

To begin contributing to Pixel 2 for Vue 3, please follow these steps:

1. Request repo acccess ( form )
2. Clone project locally
3. Install all required dependencies and packages by executing the command pnpm install, which will set up your environment for development.

Pull Request

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

• feat / feature: all changes that introduce completely new code or new features
• fix: changes that fix a bug (ideally you will additionally reference an issue if present)
• refactor: any code related change that is not a fix nor a feature
• docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage)
• build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies
• test: all changes regarding tests (adding new tests or changing existing ones)
• ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)
• chore: all changes to the repository that do not fit into any of the above categories