Skip to content

Commit a66fb59

Browse files
docs: add Contributing section, cleanup
1 parent ef1163e commit a66fb59

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,19 @@ on docker startup with the `--volume` option, or equivalent mechanism
206206
(e.g. ConfigMaps on Kubernetes / OpenShift with the
207207
[helm chart](https://github.com/helm/charts/tree/master/stable/verdaccio)).
208208

209-
## Create a Release
209+
## Development
210+
211+
### Contributing
212+
213+
Please adhere to the [verdaccio community guidelines](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md)
214+
and run all the tests before creating a PR. The commit message shall follow the
215+
conventional changelog as it is enforced via local commit hook using husky and
216+
the [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint)
217+
rule set.
218+
219+
> PR's that do not pass CI will not be reviewed.
220+
221+
### Create a Release
210222

211223
Run one of the following command to create a release:
212224

@@ -222,7 +234,7 @@ finally run
222234
yarn publish
223235
```
224236

225-
## Functional Tests
237+
### Functional Tests
226238

227239
In order to run functional tests with debug output, set the
228240
`VERDACCIO_DEBUG=true` environment variable,
@@ -232,12 +244,6 @@ In order to run functional tests with debug output, set the
232244
VERDACCIO_DEBUG=true yarn test:functional
233245
```
234246

235-
## Inspired by
236-
237-
- [verdaccio-ldap](https://github.com/Alexandre-io/verdaccio-ldap)
238-
- [node-bacstack](https://github.com/fh1ch/node-bacstack)
239-
- [verdaccio-bitbucket](https://github.com/idangozlan/verdaccio-bitbucket)
240-
241247
## License
242248

243249
[MIT](https://spdx.org/licenses/MIT)

0 commit comments

Comments
 (0)