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

Commit 3eae530

Browse files
committed
Move contribution section to the main README
1 parent 7fb170e commit 3eae530

File tree

2 files changed

+67
-62
lines changed

2 files changed

+67
-62
lines changed

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,73 @@ $ npm install @version-checker/core
4444

4545
[version-checker (axelrindle.github.io)](https://axelrindle.github.io/github-version-checker/)
4646

47+
## Contributing
48+
49+
Feel free to contribute to this project in any form.
50+
Just make sure to read the [Code of Conduct](https://github.com/axelrindle/github-version-checker/blob/main/CODE_OF_CONDUCT.md).
51+
52+
[Open an issue](https://github.com/axelrindle/github-version-checker/issues/new) if there is anything you're having problems with.
53+
54+
### Setup
55+
56+
First of all clone the git repository :)
57+
58+
```shell
59+
$ git clone https://github.com/axelrindle/github-version-checker.git
60+
```
61+
62+
and then install the dependencies
63+
64+
```shell
65+
$ npm ci
66+
```
67+
68+
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.
69+
70+
### Working on the packages
71+
72+
1. Bootstrap the Lerna environment
73+
74+
```shell
75+
$ npx lerna bootstrap
76+
```
77+
78+
2. Do your changes on a seperate branch, e.g. `feature/my-bug-fix`
79+
80+
3. When done, run tests using the following command:
81+
82+
```shell
83+
$ npx lerna run test
84+
```
85+
86+
### Contributing to the documentation
87+
88+
All documentation resided within the `docs/` directory. Is is built upon [Docusaurus](https://docusaurus.io/) and primarily written in Markdown.
89+
90+
Install dependencies using
91+
92+
```shell
93+
$ npm ci
94+
```
95+
96+
and start the development server by running
97+
98+
```shell
99+
$ npm start
100+
```
101+
102+
To produce a production build, run
103+
104+
```shell
105+
$ npm run build
106+
```
107+
108+
That produces a static site which can be served using
109+
110+
```shell
111+
$ npm run serve
112+
```
113+
47114
## License
48115

49116
[MIT](LICENSE)

docs/docs/development.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

0 commit comments

Comments
 (0)