Skip to content
This repository was archived by the owner on Dec 19, 2025. It is now read-only.

Commit 2551257

Browse files
committed
Add simple development guide
1 parent ddde991 commit 2551257

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

docs/docs/development.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
sidebar_position: 99
3+
sidebar_label: 👨‍💻 Development & Contributing
4+
---
5+
6+
# Development & Contributing
7+
8+
Be sure to read the [Code of Conduct](https://github.com/axelrindle/github-version-checker/blob/main/CODE_OF_CONDUCT.md)
9+
10+
## Setup
11+
12+
First of all clone the git repository :)
13+
14+
```shell
15+
$ git clone https://github.com/axelrindle/github-version-checker.git
16+
```
17+
18+
and then install the dependencies
19+
20+
```shell
21+
$ npm ci
22+
```
23+
24+
By running [`npm ci`](https://docs.npmjs.com/cli/v9/commands/npm-ci) instead of [`npm i`](https://docs.npmjs.com/cli/v9/commands/npm-install) it is ensured that the dependency tree is installed exactly as stated in the [`package-lock.json`](https://docs.npmjs.com/cli/v9/configuring-npm/package-lock-json) file. That guarantees the usage of identical dependency trees throughout development.
25+
26+
## Working on the packages
27+
28+
1. Bootstrap the Lerna environment
29+
30+
```shell
31+
$ npx lerna bootstrap
32+
```
33+
34+
2. Do your changes on a seperate branch, e.g. `feature/my-bug-fix`
35+
36+
## Contributing to the documentation
37+
38+
All documentation resided within the `docs/` directory. Is is built upon [Docusaurus](https://docusaurus.io/) and primarily written in Markdown.
39+
40+
Install dependencies using
41+
42+
```shell
43+
$ npm ci
44+
```
45+
46+
and start the development server by running
47+
48+
```shell
49+
$ npm start
50+
```
51+
52+
To produce a production build, run
53+
54+
```shell
55+
$ npm run build
56+
```
57+
58+
That produces a static site which can be served using
59+
60+
```shell
61+
$ npm run serve
62+
```

0 commit comments

Comments
 (0)