Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 3.43 KB
Raw

CONTRIBUTING

Thank you for investing your time in contributing to our project!

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

What you can contribute in this repo?

  • You found a new bug, and you want to fix it

  • You want to fix an existing issue

  • You've some feature suggestions (new feature, UI/UX enhancement, etc.), and you want to contribute

  • You're looking for an open-source project to

    • Contribute your energy
    • Learn and practice programming skills
    • etc.

If you found a bug, and you want to fix it

  1. If you spot a problem with the ReactShop, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
  2. Then comment that you want to fix the issue.
  3. We will assign the issue to you so that no one else will work on it simultaneously. We will provide you with maximum support.

But of course, you can fix the issue without telling us.

If you want to fix an existing issue

  1. Scan through our existing issues to find one that interests you.
  2. Then comment that you want to fix the issue.
  3. We will assign the issue to you so that no one else will work on it simultaneously. We will provide you with maximum support.

But of course, you can fix the issue without telling us.

If you have some feature suggestions, and you want to contribute

  1. Create a new thread in Discussion with the detail of your suggestion.
  2. We will discuss this with you and schedule the tasks for the feature suggestions. We will provide you with maximum support.

But of course, you can finish your contribution and create a PR without notifying us in advance.

Commit your update and PR your contribution to main project

  • Step 1 - Fork this repository.
  • Step 2 - Clone the repository to your local machine.
  • Step 3 - Add the changes to your repository.
  • Step 4 - run the command npm run lint and npm run test in order to know that nothing is broken.
  • Step 5 - Create a PULL Request from forked project to ReactShop. We may ask for changes to be made before a PR can be merge.
  • Step 6 - Congratulations 🎉🎉 Your PR is approved and Merged !!!
  • Step 7 - Thank You, You becomes one of the contributor of ReactShop 🎉🎉 .

If the steps above isn't very clear, you can search "GitHub Forks and Pull Requests" on Youtube.

LET'S CONTRIBUTE !!!