Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.3 KB

How to contribute ?

we accept contributions of all types like

  • Reporting a issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

All Changes Happen Through Pull Requests

Pull requests are the best way to propose changes. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've changed APIs, update the documentation.
  3. Issue that pull request and we will link it!

Local Development

You can run the readme-components by the following steps :-

  1. Make sure you already have a vercel account
  2. Install Vercel CLI
  3. Fork the repository and clone the code to your local machine
  4. Run the command "vercel" in the root and follow the steps there
  5. Run the command "vercel dev" to start a development server at https://localhost:3000

Bug Reports

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

Feature Request

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.