Contributing
We're happy that you're considering contributing, and any change matters.
The full contributing guide lives with the code, so it is always the version that matches it:
Read CONTRIBUTING.md in verdaccio/verdaccio →
It covers the local setup, building and running tests, debugging, the commit and pull request conventions, and changesets. Start there before you open a pull request.
Ways to contribute
- Report a bug or ask a question in the discussions.
- Fix a bug or test and triage what others reported.
- Work on an approved feature, or propose a new one in an issue first.
- Write a plugin for authentication, storage, middleware, the UI or filters, and get it listed.
- Improve the documentation: every page has an "Edit this page" link.
- Chat with us on Discord.
Where the code lives
Verdaccio is not a single repository:
- verdaccio/verdaccio: the registry, the web UI and the internal packages.
- verdaccio/website: this website and its documentation.
- verdaccio/charts: the official Helm chart.
- Plugins: most of them live in their own repositories.
Open the pull request in the repository that owns the change.
Contributing to this website
The documentation is Markdown under website/docs, the developer guides are under website/dev, and the site is built with Docusaurus.
git clone https://github.com/verdaccio/website.git
cd website
corepack enable
pnpm install
pnpm --filter @verdaccio/website start
Before you push, run pnpm lint and pnpm format:check. The repository README has the rest of the commands.
Security
Please do not report vulnerabilities in a public issue, follow the security policy.
Code of conduct
Everyone taking part is expected to follow the code of conduct.