Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 2.83 KB

README.md

File metadata and controls

93 lines (59 loc) · 2.83 KB

@fcarrascosa elements

export default {
  title: 'Info/@fcarrascosa elements',
};

DISCLAIMER

This is an experimental project in which I'm exploring the monorepo, CI/CD via Github Actions and other cool stuff, such as GitHub Pages.

The intention for this project is just for personal amusement, and it is not intended to be actively maintained (for now).

Said that, any contribution is welcome and appreciated.

Demo

There's this nice storybook demo you can check.

Installing

Prerequisites

This project relies on the the npm registry, so you might want to install either npm or yarn

Installation process

First thing you want to do to install this is cloning it into your local machine:

git clone https://github.com/fcarrascosa/fcarrascosa-elements.git

This repo uses lerna as monorepo manager, so after doing that, to install the dependencies you should run:

npx lerna bootstrap

or, as it is included in the package.json as a devDependency, I created a postinstall script that should do that for you. You can simply run:

npm install

How to contribute

INFO: This section is to be moved to a CONTRIBUTING.md file.

I love feedback. I think it's crucial to become better at what you do.

For questions or feedback

You can open a GitHub issue addressing your question or feedback. Issues templates are to be added, but will be there. In the meantime, you can ask your question and detail it as much as possible and I will try to give you the best answer I can find.

For improvements

You can open a Pull Request to this repo addressing what you are to improve. After you installed the project and you have set it up, as stated on the Installing section you should create a fix branch.

git checkout -b fix/myAwesomeFix

When you finished your improvement, and you checked everything work as expected (via tests and storybook), then you can fork this project under your namespace and add that fork to your local repo.

# add fork to your remotes
git remote add fork git@github.com:<your-user>/fcarrascosa-elements.git

# push new branch to your fork
git push -u fork fix/myAwesomeFix

NOTE: Do have in mind that this repo uses conventional-commits convention, so please, follow it.

After doing so, you can create a pull request.

Contact

Feel free to open a github issue for feedback or questions about this project.

You can also contact me via Twitter.