Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 2.25 KB

Contributing to Papanasi

Thank you for considering contributing to this open source components library! To have this kind of people in the community is awesome. Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved.

Code of Conduct

Open source community is important to us, thats why everybody involved in any intereaction should do the best posible and understand that others are doing too. By contributing to this project, you agree to uphold our Code of Conduct.

Helping with the repo

If you want to help us contributing with some code, there are some ways to do it.

Solving issues

There are some issues highlighted as help wanted that can be interesting to start to contribute in this project, some of them are bugs or enhancements that are required to improve the quality of this repository, you can filter all of them in the issues page.

Suggesting ideas

Anybody can suggest new components to be added to the repo, just create a new issue, all the ideas are welcome :)

Creating components

Right now we have three kind of components that kind inspire you to add new components to this project (or create one that is in the issues).

  • Regular component: The best example is the Button component, a regular component is a component that has all the logic managed by itslef and has no dependencies, some examples in any library can be a button, pill, switch, loading, etc.
  • Wrapper component: A good example can be the Code component, this kind of components are wrapping vanilla JavaScript libraries and converting them to universal components, like select, table, virtual-scroll, etc.
  • Layout component: There are not a lot like this, but Column component, is the example that can represent them better, are useful to improve the layout.