0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-23 22:27:34 -05:00
verdaccio/website/translated_docs/zh-Hans/contributing.md
verdacciobot cfb169be0f New Crowdin translations (#456)
* New translations ansible.md (Chinese Simplified)

* New translations packages.md (Chinese Simplified)

* New translations windows.md (Chinese Simplified)

* New translations web.md (Chinese Simplified)

* New translations use-cases.md (Chinese Simplified)

* New translations uplinks.md (Chinese Simplified)

* New translations test.md (Chinese Simplified)

* New translations ssl.md (Chinese Simplified)

* New translations server.md (Chinese Simplified)

* New translations reverse-proxy.md (Chinese Simplified)

* New translations repositories.md (Chinese Simplified)

* New translations protect-your-dependencies.md (Chinese Simplified)

* New translations plugins.md (Chinese Simplified)

* New translations notifications.md (Chinese Simplified)

* New translations auth.md (Chinese Simplified)

* New translations logger.md (Chinese Simplified)

* New translations kubernetes.md (Chinese Simplified)

* New translations install.md (Chinese Simplified)

* New translations index.md (Chinese Simplified)

* New translations iis-server.md (Chinese Simplified)

* New translations home.md (Chinese Simplified)

* New translations docker.md (Chinese Simplified)

* New translations dev-plugins.md (Chinese Simplified)

* New translations contributing.md (Chinese Simplified)

* New translations config.md (Chinese Simplified)

* New translations cli.md (Chinese Simplified)

* New translations build.md (Chinese Simplified)

* New translations en.json (Chinese Simplified)

* New translations en.json (Chinese Simplified)

* New translations en.json (Chinese Simplified)

* New translations en.json (Chinese Simplified)

* New translations install.md (Chinese Simplified)

* New translations install.md (Chinese Simplified)

* New translations home.md (Chinese Simplified)

* New translations cli.md (Chinese Simplified)

* New translations config.md (Chinese Simplified)

* New translations config.md (Chinese Simplified)

* New translations config.md (Chinese Simplified)

* New translations auth.md (Chinese Simplified)

* New translations config.md (Chinese Simplified)

* New translations auth.md (Chinese Simplified)

* New translations auth.md (Chinese Simplified)

* New translations config.md (Chinese Simplified)

* New translations en.json (Spanish)

* New translations en.json (Spanish)

* New translations en.json (Spanish)

* New translations en.json (Spanish)

* New translations en.json (Spanish)

* New translations config.md (Chinese Simplified)

* New translations config.md (Spanish)

* New translations config.md (Urdu (Pakistan))

* New translations config.md (Chinese Traditional, Hong Kong)

* New translations config.md (Portuguese, Brazilian)

* New translations config.md (Chinese Traditional)
2018-01-08 20:45:03 +01:00

3 KiB

id date title
contributing 2017-07-10T23:36:56.503Z Contributing Verdaccio

First of all 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:

Getting started

As a first glance verdaccio is a single repository, but there are many ways you might contribute and a 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.

We have a long list of plugins ready to be used and improved but at the same time you might create your own.

I would prefer to 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 dependencies as eslint, stylelint, webpack. You migt 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.

Here some ideas:

  • Create a common eslint rules to be used across all dependencies or plugins
  • Improve Flow types definitions delivery
  • Moving to Webpack 4
  • Update to React 16
  • Improve hot reload with Webpack
  • We use babel and webpack across all dependencies, why not a common preset?

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/ 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/ that need maintenance and pretty likely huge improvements, we need your knowledge for the benefits of all users.

We have support for Kubernetes, 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 and I'm willing to start right away" then I have good news for you, that's the next step.

You will need learn how to build, we have prepared a guide just for that.

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.