FCID Component Library
Setting up the project
Navigate to the directory containing the codebase. Run 'yarn' to install the packages and dependencies.
Running the project locally
In your terminal, navigate to the repository and enter the command 'yarn start'. In your web browser, go to http://localhost:4200/
Running Storybook
In your terminal, navigate to the repository and enter the command 'yarn storybook'. When successfully compiled, go to http://localhost:6006/ in your web browser.
Contributing Guidelines
In order for a contribution to be considered for a PR, the changes should have at a minimum:
- Unit tests (meaningful unit testing of expected outcomes/behavior/results)
- Storybook (if applicable)
- Typing (if utilizing an 'any' type, be prepared to explain why it is appropriate)
Changes should also ensure the code follows the Atomic design pattern.
Because many applications may be consuming this library, it is especially important to follow the Open-Closed Principle. Objects or entities should be open for extension but closed for modification. Do not introduce a change that will cause current implementations to change or behave unexpectedly.
1 year ago