Thank you for considering contributing to Aplós! This project is open-source and welcomes contributions from everyone. By participating, you are expected to uphold this code of conduct.
If you're new to contributing to open-source projects, you can start by checking out the GitHub documentation on how to contribute to a project.
They are mandatory, but they are recommended to make the contribution process smoother.
-
Ensure that your pull request is up-to-date with the
mainbranch. -
Make sure that your code is well-documented and follows the conventional commit guidelines.
The formatting is done automatically with Prettier and ESLint, so you don't have to worry about that 😄.
If you want to contribute to Aplós, make sure to fork the repository and cloned it with git clone or gh repo clone.
After cloning the repository, you can install the dependencies with the following command:
pnpm installIf you want a development server, you can directly run the Docs for development using the following command:
pnpm docs:devYou can edit the project and see your changes live.
All other standard VitePress commands are available, like pnpm demo:build and pnpm demo:preview.
Check the Boosts repository to see how to add a new Boost to Aplós.