@truehome-assets/loft-ui v0.19.0

Getting Started with Landing Components

Landing Components is the new initiative to create, manage and maintain reusable React components used in Loft México projects, and its purpose is to replace the old TrueHome UI components library.

<WIP: Add official Story Book documentation environment link here>

Installation

Install library dependencies:

npm i @truehome-assets/loft-ui

Contributing

To contribute new components, or fix errors in the existing ones, you need to open a pull request into the official Landing Components repository.

If you don't know how to make your first contribution, follow the next steps:

Run Project Locally

Clone project repository to your local:

git clone https://truehome-holdings@dev.azure.com/truehome-holdings/Core/_git/landing-components

Install project dependencies:

npm install

Run project locally:

npm start

Now you can start developing your contribution.

Running Unit Tests

To run the project's unit tests, execute the command:

npm run test

Contribution Guidelines

For your contribution to be accepted, be sure to cover all this requirements:

1. Follow the existing code's format. Be sure to have prettier extension enabled before making your contribution.
2. Follow the existing project files structure. Don't leave files everywhere or create new folders that don't fit into the existing structure.
3. Add unit tests or modify the existing ones to cover all the acceptance criteria of the components to ensure its code quality.
4. Follow project's coding guidelines. Take a look to the Airbnb JavaScript Style guide.

Opening a Pull Request

Before pushing your contribution to a remote branch, be sure that your branch's name indicates what kind of contribution you are making:

• fix/<fix-name>. Contributions that fix existing errors in components that aren't in a production environment.
• hotfix/<hot-fix-name>. Contributions that fix errors in components that are in a production environment.
• feat/<feat-name>. Contributions that add a new component.

Once your branch is named correctly, and you are sure you have covered all the contribution guidelines, you are now ready to open the pull request.

Please, try to be very specific and detailed at your pull request's description. Reviewing a pull request is a difficult process where posible fixes and improvements are catched.

Now that your pull request is opened, it will be reviewed by the project administrator and moderator, and you will receive feedback if some modifications or improvements needs to be made to your contribution.