Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.57 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. Commit to your local fork using Semantic Commit Messages
  7. Create a PR with title based using Semantic Commit Messages For example: feat: add new TextArea component
  8. Go over the checklist in the PR and make sure that all checks are passed
  9. Wait for the Design and Code review
  10. Enjoy your change after merge!

Information about the project

Plop

Every new component in this repository should be created using plops with npm run plop command. Plop will automatically generate all required files for your new component. Plop template will always be up to date and by using it, you can be sure that your component will be created with the latest recommended structure.

Storybook

As the main development environment and documentation playground we are using Storybook. Each component should be developed in isolation in the Storybook environment.

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 are using 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"