Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.66 KB
Raw

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

It takes a lot of courage to even visit this section. I sincerely appreciate it. Please follow the guidelines in this document to get you started with the repo and codebase.

Feature Request ✨

  1. Make sure there is no body suggested your feature before
  2. Follow the "Feature Request" template
  3. Keep discussing with the team to find the best way to impelement your feature

Bug Report 🐛

  1. Make sure there is no body suggested your feature before
  2. Follow the "Bug Report" template

Contributing 🛠

  1. Follow Feature request rules to add a feature request ( ex. [ Feature Request ] Add "party 🎈" feature )
  2. Fork the repo
  3. Clone the repo git clone <your-fork-url>
  4. Create new branch ( ex. feat/party ) for more details follow gitflow rules
  5. Follow the steps of Development section
  6. Commit your work linked with the issue ( ex. close #1 )
  7. Push the changes to the fork git push fork feat/add-party
  8. Create pull request from your branch feat/party to our master branch

Development 👨‍💻

  1. Install dependencies: npm i or yarn
  2. Run the dev server: npm run dev or yarn dev it will show all components list on localhost:3000; For full docs go to /docs, run npm i && npm run dev
  3. Edit the source code within /src
  4. Check changes on localhost:3000
  5. Commit your work git commit -m "feat( fun ): add a party" for more details check Conventional Commits specification