Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

61 lines (46 loc) · 3.53 KB
Raw

Contribution guidelines

This is an official library of shared UI components for Monday builders. It is used both for internal and external Monday apps development.

This library is open-sourced, and we encourage everyone to use and contribute into it.

How to contribute

  1. Create a fork of this repository
  2. Please use the correct node version it is listed in the .nvmrc file (you can use nvm use in order to switch to the right node version).
  3. Install dependencies with npm install command
  4. Sync from upstream if needed
  5. Run Storybook environment locally with npm run storybook command.
  6. Make sure all components behave as expected by running all Jest tests locally with 'npm run test'.
  7. If there are changes in some of the library snapshot tests, make sure all changes are intentional. If they are, update them with 'npm run test:update'.
  8. Commit to your local fork using Semantic Commit Messages
  9. Create a PR with title based using Semantic Commit Messages For example: feat: add new TextArea component
  10. Go over the checklist in the PR and make sure that all checks are passed
  11. Wait for the Design and Code review
  12. Enjoy your change after merge!

Information about the project

Creating new files in the library

Our code generator, Plop, is designed to simplify the creation of frequently used boilerplate code. To utilize it, execute the command npm run plop. If you want to learn more about Plop, you can find additional information here. Currently, our Plop code generator supports the creation of the following:

  1. Tests
  2. Component story documentation pages
  3. Hook story documentation pages
  4. Entirely new components, which include tests and story pages

We strongly recommend utilizing our Plop code generator within this repository for generating any of the mentioned items. Doing so ensures that your code will be created with the latest recommended structure, providing a solid foundation for your development tasks.

API

If you add new features or abilities to an existing component, please ensure your props' naming follows our conventions and best practices. Read more about it here.

Storybook

As the main development environment and documentation playground, we are using Storybook. Each component should be developed in isolation in the Storybook environment. You can read more about our docs implementation best practices here.

Theming

Every component should support theming, you can find more information about it here.

Tests and coverage

All the guidelines about testing your new component or changes to the existing one you can find here.

Linting

We use Prettier with the default community guidelines. Please, make sure that you are formatting your code with prettier.

Commits

We are using Semantic commits convention for creating Pull Requests and commits messages inside of the Pull Request.

Releasing

To release a new version, you can run the "Release new version" workflow.

If you want to run it locally, you can do so with Github's CLI:

$ gh workflow run "Release new version"