|
2 | 2 |
|
3 | 3 | ### Issue |
4 | 4 |
|
5 | | -1. Make sure you're using the latest version, check [releases](https://github.com/Simonwep/selection/releases/tag/2.1.2) for that. |
6 | | -2. [Use the search](https://github.com/Simonwep/selection/search?type=Issues), maybe there is already an answer. |
7 | | -3. If not found, [create an issue](https://github.com/Simonwep/selection/issues/new), please dont forget to carefully describe it how to reproduce it / pay attention to the issue-template. |
| 5 | +* Make sure you're using the latest version, check [releases](https://github.com/simonwep/viselect/releases/tag/2.1.2) for that. |
| 6 | +* [Use the search](https://github.com/simonwep/viselect/search?type=Issues), maybe there is already an answer. |
| 7 | +* If not found, [create an issue](https://github.com/simonwep/viselect/issues/new), please don't forget to carefully describe it how to reproduce it / pay attention to the issue-template. |
8 | 8 |
|
9 | 9 | *** |
10 | 10 |
|
11 | 11 | ### Pull Request |
12 | 12 |
|
13 | | -1. Pull requests only into the [master](https://github.com/Simonwep/selection/tree/master) branch. |
| 13 | +* Pull requests only into the [master](https://github.com/simonwep/viselect/tree/master) branch. |
| 14 | +* Make sure to use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/): |
| 15 | + - `docs: ` - for changes in the documentation. |
| 16 | + - `feat([package]): ` - for new features in the corresponding package. |
| 17 | + - `fix([package]): ` - for bug fixes in the corresponding package. |
| 18 | + - `refactor([package]): ` - for changes in the code that neither fixes a bug nor adds a feature. |
| 19 | + - `chore: ` - for changes in the build process or auxiliary tools. |
14 | 20 |
|
15 | 21 | *** |
16 | 22 |
|
17 | | -#### Setup |
| 23 | +### Working on the library |
18 | 24 |
|
19 | 25 | This project requires [pnpm](https://pnpm.io) and [node](https://nodejs.org/en/). |
20 | | - |
21 | | -1. Fork this repo on [GitHub](https://github.com/Simonwep/selection). |
| 26 | + |
| 27 | +1. Fork this repo on [GitHub](https://github.com/simonwep/viselect). |
22 | 28 | 2. Check out the master locally. |
23 | 29 | 3. From your local repro run `pnpm install`. |
24 | | -4. Run `pnpm start dev`. |
| 30 | +4. Run `pnpm start dev` to start a dev server for all packages. |
| 31 | + |
| 32 | +#### Working on the docs |
| 33 | + |
| 34 | +This project uses [vitepress](https://vitepress.dev/) for the documentation. |
| 35 | +Use the `docs:` commands to work on the documentation. |
0 commit comments