we accept contributions of all types like
- Reporting a issue
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
Pull requests are the best way to propose changes. We actively welcome your pull requests:
- Fork the repo and create your branch from
master
. - If you've changed APIs, update the documentation.
- Issue that pull request and we will link it!
You can run the readme-components by the following steps :-
- Make sure you already have a vercel account
- Install Vercel CLI
- Fork the repository and clone the code to your local machine
- Run the command "vercel" in the root and follow the steps there
- Run the command "vercel dev" to start a development server at https://localhost:3000
Good bug report should contain:
- Title
- Description
- Steps to reproduce the bug
- Share the screenshot, if possible.
- What actually happens
- What you expected would happen
Great Feature Requests tend to have:
- A quick idea summary
- What & why you wanted to add the specific feature
- Additional Context like images, links to resources to implement the feature if you have any.