12 KiB
Contributing
Any change matters, whatever the size, just do it.
We are happy that you are willing to contribute. For that reason, we have prepared these guidelines for you:
Table of Contents
- Contributing
How Do I Contribute?
There are different ways to contribute, each comes with a different levels of tasks, such as:
- Report a bug.
- Request a feature you think would be great for verdaccio.
- Fix bugs.
- Test and triage reported bugs by others.
- Work on requested/approved features.
- Improve the codebase (lint, naming, comments, test descriptions, etc...)
Verdaccio has several areas of involvement, which might fit you better, eg:
- Core: The core is the main repository, built with Node.js.
- Website: we uses Gatsby.js for the website and if you are familiar with this technology, you might become the official webmaster.
- User Interface: The user Interface is based in react and material-ui and looking for front-end contributors.
- Kubernetes and Helm: Ts the official repository for the Helm chart.
There are other areas to contribute, like documentation, translation which are not hosted on this repo but check the last section of this notes for further information.
Development Setup
Verdaccio uses pnpm as package manager for development in this repository. Please install the latest one:
npm i -g pnpm
First step is installing all dependencies:
pnpm install
Building the project
To build the project run
pnpm build
Running test
pnpm test
Verdaccio is a mono repository, for running an specific test or package go the specific package eg:
cd packages/store
pnpm test
or an specific test in that package
pnpm test test/merge.dist.tags.spec.ts
or a single test unit
pnpm test test/merge.dist.tags.spec.ts -- -t 'simple'
The coverage is enabled by default, to speed up test running
pnpm test test/merge.dist.tags.spec.ts -- -t 'simple' --coverage=false
To increase debug output, we use debug, to enable it in your test just add
DEBUG=verdaccio* pnpm test
More details in the debug section
Running and debugging
We uses debug for debug outcome. Each package has it owns namespace.
Debugging compiled code
Currently you can only run in debug mode pre-compiled packages, to enable debug while running add the verdaccio namespace using the DEBUG environment variable, like this:
DEBUG=verdaccio:* node packages/verdaccio/debug/bootstrap.js
On this way can be reviewed every package, but if you need to filter out and display more specific output, increase the name space filter.
DEBUG=verdaccio:plugin:* node packages/verdaccio/debug/bootstrap.js
The debug code is intended to analyze what is happening under the hood and none of the output is gathered with the logger module.
Reporting Bugs
Bugs are considered features that are not working as described in documentation.
If you've found a bug in Verdaccio that isn't a security risk, please file a report in our issue tracker.
NOTE: Verdaccio still does not support all npm commands. Some were not considered important and others have not been requested yet.
Read the documentation
Check whether you are using the software in the way is documented documentation.
What's is not considered a bug?
- Third party integrations: proxies integrations, external plugins.
- Package managers: If a package manager does not support a specific command or cannot be reproduced with another package manager.
- Features clearly flagged as not supported.
- Node.js issues installation in any platform: If you cannot install the global package ( this is considered external issue)
- Any ticket which has the flagged as external issue.
If you intent to report a security issue, please follow our Security policy guidelines.
Issue Search
Before consider report a bug, please follow this steps before:
- Search if has already been reported via the issue search.
- Look for the question label: we have labelled questions for easy follow-up as questions.
In case any of those match with your search, up-vote it (using GitHub reactions) or add additional helpful details to the existing issue to show that it's affecting multiple people.
Chat
Questions can be asked via Discord
Please use the #help channel.
Request Features
New feature requests are welcome. Analyse whether the idea fits within scope of the project. Then, detail your request, ensuring context and use case is provided.
Please provide:
- A detailed description the advantages of your request
- Whether or not it's compatible with
npm,pnpmand yarn classic or yarn berry. - A potential implementation or design
- Whatever else you have in your mind 🤓
Contributing Guidelines
This is the most exciting part, when you became a Verdaccio contributor 🙌🏼, to ensure a fast code review and merge, please follow the next guidelines:
Any contribution gives you the right to be part of this organization as collaborator.
Submitting a Pull Request
The following are the steps you should follow when creating a pull request. Subsequent pull requests only need to follow step 3 and beyond.
- Fork the repository on GitHub
- Clone the forked repository to your machine
- Make your changes and commit them to your local repository
- Rebase and push your commits to your GitHub remote fork/repository
- Issue a Pull Request to the official repository
- Your Pull Request is reviewed by a committer and merged into the repository
NOTE: While there are other ways to accomplish the steps using other tools,
the examples here will assume most actions will be performed via git on
command line.
For more information on maintaining a fork, please see the GitHub Help article titled Fork a Repo, and information on rebasing.
Make Changes and Commit
Caveats
Feel free to commit as much times you want in your branch, but keep on mind on this repository we git squash on merge by default, any other way is forbidden since we intent to have a clean git history.
Before Commit
Before committing, you must ensure there are no linting errors and all tests pass.
To do this, run these commands before create the PR:
pnpm lint
pnpm format
pnpm build
pnpm test
note: eslint and formatting are running separately, keep code formatting before push.
All good? perfect, then you should create the pull request.
Commit Guidelines
For example:
feat: A new featurefix: A bug fix
A commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
e.g.:
feat: xxxxxxxxxx
A commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
e.g.:
fix: xxxxxxxxxxx
Commits types such as as docs:,style:,refactor:,perf:,test:
and chore: are valid but have no effect on versioning. It would be great if you use them.
All commits message are going to be validated when they are created using husky hooks.
Please, try to provide one single commit to help a clean and easy merge process.
Adding a changeset
We use changesets in order to generate a detailed Changelog as possible.
Add a changeset with your Pull Request is essential if you want your contribution get merged. To create a changeset please run:
pnpm changeset
Then select the packages you want to include in your changeset navigating through them and press the spacebar to check it, on finish press enter to move to the next step.
🦋 Which packages would you like to include? …
✔ changed packages
changed packages
✔ @verdaccio/api
✔ @verdaccio/auth
✔ @verdaccio/cli
✔ @verdaccio/config
✔ @verdaccio/commons-api
The next question would be if you want a major bump, this is not the usual scenario, most likely would be a patch, in that case press enter 2 times (to skip minor)
🦋 Which packages should have a major bump? …
✔ all packages
✔ @verdaccio/config@5.0.0-alpha.0
Once the desired bump you need, the CLI will ask for a summary, here you have fully freedom what to include.
🦋 Which packages would you like to include? · @verdaccio/config
🦋 Which packages should have a major bump? · No items were selected
🦋 Which packages should have a minor bump? · No items were selected
🦋 The following packages will be patch bumped:
🦋 @verdaccio/config@5.0.0-alpha.0
🦋 Please enter a summary for this change (this will be in the changelogs). Submit empty line to open external editor
🦋 Summary ›
The last step is confirm your changeset or abort the operation.
🦋 Is this your desired changeset? (Y/n) · true
🦋 Changeset added! - you can now commit it
🦋
🦋 If you want to modify or expand on the changeset summary, you can find it here
🦋 info /Users/user/verdaccio.clone/.changeset/light-scissors-smell.md
Once the changeset is added (all will have an unique name) you can freely edit using markdown, adding additional information, code snippets or what you consider is relevant.
All that information will be part of the changelog, be concise but informative. It is considered a good option to add your nickname and GitHub link to your profile.
PRs that do not follow the commit message guidelines will not be merged.
Update Tests
Any change in source code must include test updates.
If you need help with how testing works, please refer to the following guide.
If you are introducing new features, you MUST include new tests. PRs for features without tests will not be merged.
Develop Plugins
Plugins are add-ons that extend the functionality of the application.
If you want to develop your own plugin:
- Check whether there is a legacy Sinopia plugin for the feature that you need via npmjs
- Keep in mind the life-cycle to load a plugin
- You are free to host your plugin in your repository
- Provide a detailed description of your plugin to help users understand how to use it.