react-fluo
Version:
A react library that can be used to highlight and comment parts of a given text. The highlights and comments are both configurable to blend with the user's design and needs
25 lines (14 loc) • 859 B
Markdown
# Contributing
Found a bug? Want a new feature? Don't like the docs? Please send a pull request or raise an issue.
### Raising issues
When raising an issue, please add as many details as possible. Screenshots, video recordings, or anything else that can make it easier to reproduce the bug you are reporting.
### Creating Pull Requests
This library is a work in progress and pull requests are always welcome. In order to make the review more accessible, please make sure that they have:
* A good title and description message
* A video or pictures depicting the changes
* A story if a new, independent component is added
* Descriptive commits
##### How to set up the development environment
1. Clone the repository
2. Install dependencies with `npm install` or `yarn install`
3. To develop with storybook run `npm run storybook` or `yarn stroybook`