Infrastructure/verdaccio
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-27 22:59:51 -05:00
Code Issues Activity

docs: update dev documentation

Browse source
This commit is contained in:
Juan Picado @jotadeveloper 2017-10-29 08:20:48 +01:00
parent 57e2b168ab
commit 177d28b42e
No known key found for this signature in database
GPG key ID: 18AC54485952D158
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
wiki/dev/README.md
View file

@ -1,15 +1,15 @@
# Contributing
First of all 👏👏 thanks for visiting this page, for us means you are willing to contribute `verdaccio` and we are happy for that. Jumping into a unfamiliar code base is not easy but we are here to help you.
First of all 👏👏 thanks for visiting this page, for us means you are willing contribute to `verdaccio` and we are happy for that. Jumping into an unfamiliar code base is not easy but we are here to help you.
## Comunication Channels
If you are willing for asking we use two channels for discussions:
If you are willing for asking, we use two channels for discussions:
* [Public Gitter channel](https://gitter.im/verdaccio/)
* [Contributors Slack channel](https://verdaccio-npm.slack.com) (unfortunately only by email invitation, you might ask in Gitter to be included)
## Firts steps
## First steps
As a first glance verdaccio is a single repository, but there are many ways you might contribute and variety of technologies to practice.
@ -21,6 +21,8 @@ All we have different skills, so, let's see where you might feel comfortable.
Node.js is the base of `verdaccio`, we use libraries as `express`, `commander`, `request` or `async`. Verdaccio is basically a Rest API that create a communication with `npm` clients compatible, as `yarn`.
We have a long [list of plugins](https://github.com/verdaccio/verdaccio/blob/master/wiki/plugins.md) ready to be used and improved but at the same time [you might create your own](plugin.md).
#### I would prefer work in the User Interface
Recently we have moved to modern techonologies as `React` and `element-react`.
@ -51,3 +53,4 @@ You will need learn how to build, [we have prepared a guide just for that](build
Once you have played around with all scripts and you know how to use them, we are ready to go to the next step, run the [**Unit Test**](test.md).