Skip to content

Latest commit

 

History

History
121 lines (77 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

121 lines (77 loc) · 3.74 KB
Raw

🤝First time contributing? We will help you out.👍

GitHub custom open for collaboration

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

If you don't have git on your machine, install it.

💥 How to Contribute

PRs Welcome Open Source Love

  • Take a look at the Existing Issues or create your own Issues!
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Read the Code of Conduct
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
  • Add Screenshots to help us know what this Script is all about.

How to make a Pull Request

If you think that you can add a new feature or want to fix a bug. We invite you to contribute to Lets-Shop and make this project better. To start contributing, follow the below instructions:

  1. Create a folder at your desire location (usually at your desktop).

  2. Open Git Bash Here

  3. Create a Git repository.

    Run command git init

  4. Fork the repository.

  5. Clone your forked repository of project.

git clone https://github.com/<your_username>/Lets-Shop.git
  1. Navigate to the project directory.
cd Lets-Shop
  1. Add a reference(remote) to the original repository.
git remote add upstream https://github.com/websycode/Lets-Shop.git
  1. Check the remotes for this repository.
git remote -v
  1. Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository.
git pull upstream main
  1. Create a new branch(prefer a branch name that relates to your assigned issue).
git checkout -b <YOUR_BRANCH_NAME>
  1. Perform your desired changes to the code base.

  1. Check your changes.
git status

git  diff
  1. Stage your changes.
git add . <\files_that_you_made_changes>
  1. Commit your changes.
git commit -m "relavant message"
  1. Push the committed changes in your feature branch to your remote repository.
git push -u origin <your_branch_name>

  1. To create a pull request, click on compare and pull requests.

  2. Add appropriate title and description to your PR explaining your changes.

  3. Click on Create pull request.

Congratulations🎉, you have made a PR to the Lets-Shop. Wait for your submission to be accepted and your PR to be merged by a maintainer.
Show some ❤️ by starring🌟 the repository! Follow for more updates.