Good First Issue For Contributors

[juanpicado]

Hi, if you are reading this is because you pretty likely don't know how to start 🤔 . Fair enough!

⚠️ Use the branch master and don't forget to [read the contribution guidelines])https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md).
Every contribution is shown at this page automatically https://verdaccio.org/contributors

So, let's work on that 🚸 !

Good First Issue Board https://github.com/verdaccio/verdaccio/projects/18

What should I know before starting?

All here we are developers, with different backgrounds, languages, and objectives. But, we must follow certain rules so we can understand each other and make communication easier as possible. Please 👍 read your code of conduct, long story short, just be nice with everybody around here.

• Code guidelines: we enforce them using eslint, so you don't have to read a long list of rules, we love automation 🤖 .
• Commit guidelines: We follow the semantic versioning approach, this is really important so your PR will appear on the Changelog 🎉 ! I guess you expect recognition and we will give it to you.

That's all you need to know before starting.

What can I do?

I'd assume you are completely lost 😩, that's fine! I was it when I get started on this. Let me help you.

If you are interested in Typescript in general, here some ideas you might help

• Get rid of @ts-ignore.
• Enable noImplicitAny progressively by package, it is disabled globally 😢
  • Upgraded few packages already, more pending
• Remove any and add proper types.
• Fix eslint warnings for @typescript-eslint/xxx.
• Improve our @types https://github.com/verdaccio/verdaccio/tree/5.x/packages/core/types (better naming, document each type, remove duplications)

If you are interested mostly in Front-End, we use React@17.x

• Upgrade to React 18
• Upgrade testing library
• Remove warnings on run test cd packages/plugins/ui-theme && pnpm test

• Upgrade material-ui@5 feat: migrate to Material-UI 5 #2612
  After migration there are few areas that also require some work, like the following:

  • Use autocomplete on language switch and get rid of packages/plugins/ui-theme/src/components/AutoComplete/AutoCompleteV2.tsx
  • After this migration we could improve the UI, add new features.
  • Get rid of MUI: adaptV4Theme() is deprecated. warning
  • Fix tons or warnings due migration (running tests, and possibly also in dev mode)

• Migrate components to React Hooks https://github.com/verdaccio/ui/issues/116

• Increase component coverage (react-testing-library)

• Move UI translations to crowdin

• Add i18n to the UI https://github.com/verdaccio/ui/issues/102

If you like Docker:

• Add new examples, integrations with Apache, Nginx, or whatever is missing and help others to do it themselves. https://github.com/verdaccio/docker-examples
• Improve Helm Charts https://github.com/verdaccio/charts

If you like Website:

• [ ] New website design (New Website Design website#75) Contribute here -> chore: website scaffolding  #1843
• Update to Docusaurus V2
• Translate to new languages

If you like GitHub Actions:

• Put on shape our actions https://github.com/verdaccio/github-actions

In general, you might help with other things as:

• Rename variable names 👍 if you consider is not well readable
• Fix FIXME:// comments
• Add new plugins for the community here ⚠️ we will add some guidelines on how to do it.
• Fix // eslint-disable-next-line new-cap eslint inline comments
• Add/Fix/Improve test to Verdaccio, here a complete guideline.

If you have any suggestions, just feel free to comment on this thread, or chat with me over Discord 🙃 , if you are shy I accept DM over Discord. Let's us help you to grow in Open Source.

🗣 https://discord.gg/fSCsRvu

Before PR

• Keep the PR small as possible and one single topic for each
• If you don't change the logic, then ignore modify the test if you don't need it

[juanpicado]

Thanks guys ! I will share soon the stats of contributions 🥳🥰 https://verdaccio.org/contributors