verdaccio/wiki/dev/README.md

# 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.

## Comunication Channels

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

As a first glance verdaccio is a single repository, but there are many ways you might contribute and variety of technologies to practice.

### Finding my spot

All we have different skills, so, let's see where you might feel comfortable.

#### I know or I want to learn Node.js 

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`. 

#### I would prefer work in the User Interface

Recently we have moved to modern techonologies as `React` and `element-react`.  

#### I feel more confortable improving the stack

Of course we will be happy to help us improving the stack, you can upgrade dependenciesas `eslint`, `stylelint`, `webpack`. Or merely improve the `webpack` configuration would be great. Any suggestion is very welcome. Furthermore whether you have experience with **Yeoman** you might help us with the [verdaccio generator](https://github.com/verdaccio/generator-verdaccio-plugin).

#### I do great Documentation

Many contributors find typos and grammar issues, that also helps to improve the overall experience for troubleshooting.

#### I am a Designer

We have a frontend website [http://www.verdaccio.org/](http://www.verdaccio.org/) that will be happy to see your ideas.

#### I am a DevOps

We have a widely popular Docker image [https://hub.docker.com/r/verdaccio/verdaccio/](https://hub.docker.com/r/verdaccio/verdaccio/) that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.

We have support for **Puppet**, **Ansible** and **Cheff** and we need help in those fields, feel free to see all repositories.

## I'm ready to contribute

If you are thinking *"I've seen already the [repositories](repositories.md) and I'm willing to start right away"*  then I have good nws for you, that's the next step.

You will need learn how to build, [we have prepared a guide just for that](build.md).

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).
docs: add development documentation, contribution guides, etc, wip 2017-10-28 22:36:18 +02:00			`# 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.

			`## Comunication Channels`

			`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`

docs: update dev documentation 2017-10-29 08:00:29 +01:00			`As a first glance verdaccio is a single repository, but there are many ways you might contribute and variety of technologies to practice.`
docs: add development documentation, contribution guides, etc, wip 2017-10-28 22:36:18 +02:00
			`### Finding my spot`

docs: update dev documentation 2017-10-29 08:00:29 +01:00			`All we have different skills, so, let's see where you might feel comfortable.`

docs: add development documentation, contribution guides, etc, wip 2017-10-28 22:36:18 +02:00			`#### I know or I want to learn Node.js`

			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`.

			`#### I would prefer work in the User Interface`

			Recently we have moved to modern techonologies as `React` and `element-react`.

			`#### I feel more confortable improving the stack`

			Of course we will be happy to help us improving the stack, you can upgrade dependenciesas `eslint`, `stylelint`, `webpack`. Or merely improve the `webpack` configuration would be great. Any suggestion is very welcome. Furthermore whether you have experience with Yeoman you might help us with the [verdaccio generator](https://github.com/verdaccio/generator-verdaccio-plugin).

			`#### I do great Documentation`

			`Many contributors find typos and grammar issues, that also helps to improve the overall experience for troubleshooting.`

			`#### I am a Designer`

			`We have a frontend website [http://www.verdaccio.org/](http://www.verdaccio.org/) that will be happy to see your ideas.`

			`#### I am a DevOps`

			`We have a widely popular Docker image [https://hub.docker.com/r/verdaccio/verdaccio/](https://hub.docker.com/r/verdaccio/verdaccio/) that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.`

			`We have support for Puppet, Ansible and Cheff and we need help in those fields, feel free to see all repositories.`

			`## I'm ready to contribute`

			`If you are thinking "I've seen already the [repositories](repositories.md) and I'm willing to start right away" then I have good nws for you, that's the next step.`

			`You will need learn how to build, [we have prepared a guide just for that](build.md).`

			`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).`