Skip to content

Latest commit

 

History

History
134 lines (79 loc) · 5.68 KB

CONTRIBUTING.md

File metadata and controls

134 lines (79 loc) · 5.68 KB
Raw

Contributing to amazon clone

Hurray!, you're here!✨. This is the first step in making your contribution to the amazon clone project. This documentation will serve as a guide for making your contibutions to this project. Follow the steps stated below carefully.

Finally, we can't wait to see your outstanding issues and pull requests. Welcome 😇❤

Ground Rules

Here at amazon clone, we welcome everyone to contriubute to our project. You can contribute in several ways not just in code (E.g. Technical writing).

Having numerous means of contributing means working with alot of individuals which is very good for the growth 📈 of the project but most times can lead to conflicting interests and point of views 👈👉. Below are set of rules 📖 that guide individuals participating in this project.

  • Openess 👐. Collaboration is only possible if everyone is open to share ideas.
  • Respect 👨🏾‍🤝‍👨🏽. Having respect for everyone, their skills and opinions is paramount.
  • Welcoming tone 😇💃: It is expected that you interact with others in an optimistic and cheerful manner.

Your First Contribution

Is this your first time contributing to an open source project? If yes, Welcome!!✨🎉💃🏾 Here is a great tutorial on how to contribute to an open source project.

At the point you are ready to take on the world of open source contribution!!.

You must have seen a bug or problem you can fix, this is when you open a new issue for that problem. Let's do it together.

Steps to open a new issue

  • Step 1: Navigate to the issues naviagtion button. See below 👇

issues1

  • Step 2: Scan through the currently opened issues to see if your issue(s) has been listed earlier. See below 👇

issues2

  • Step 3: If your issue hasn't been listed yet, click on the New issue button at the top right corner to add your new issue. See below 👇

issues3

  • Step 4: Time to add your amazing issue. You add the title and a brief description of the issue. For further explanation, images can be added as well. See below 👇

issues4

  • Step 5: Submit the issue. See below 👇

issues5

Hurray, you just made added your first issue. The managers of amazon clone will now review your issue and you will either get assigned to the issue, have it closed or a comment will be dropped for you.

You have been assigned an issue 🥂 and are confused 😵 about where to go from here, follow this guide below to make your changes and pull request 🍾.

Getting Started

Fork the amazon clone repository. See below 👇

fork

Clone the repository you forked above. See below 👇

clone

Using the command below, you can clone the repo.

git clone https://github.com/Kanika637/amazon-clone.git

Navigate to the cloned directory using command line. See below 👇

cd amazon-clone

Install all the dependencies. See below 👇

npm i

Make a new branch. See below 👇

branch


git checkout -b "Your Branch Name"

A good branch name would begin with the issue ticket and the assigned issue. See below 👇

// #343 is the issu ticket number and make a request is the assigned issue na

git checkout -b "#343-make a request"

You are all set!! 🍾🎉. You can now make your changes locally. Once you are done making all your changes, you can now push code and make a pull request.

Steps to making a pull request

You have to switch to the main branch and make sure it's up to date with the amazon's clone main branch. To do so, use the following commands below.

git remote add upstream https://github.com/Kanika637/amazon-clone.git
git checkout main
git pull upstream main

You can now update your branch from your local copy of main, and push it!. See how below. 👇

git checkout #343-make a request
git rebase main
git push --set-upstream origin #343-make a request

Hurray!!, we are done with the hard part. Head to github to make the pull request Github will check for conflicts and if non is found, you can make the pull request and the mainteners of amazon clone will review your pull request to have it merged or make a comment on it.

Code review process

The maintainer of amazon-clone looks at Pull Requests on a regular basis and carries out merging or comments on the requests. You can close a pull request if it isn't showing any activity after two weeks.

Commit messages

Amazon-clone has certain conventions that should be adopted when contributing.

Commit message conventions.

  • Commit test files with test: ... prefix
  • Commit bug fixes with fix: ... prefix
  • Commit new features with feat: ... prefix
  • Commit changes to package.json, .gitignore and other meta files with chore(filenamewithoutext): ...
  • Commit changes to README files or comments with docs: ...
  • Cody style changes with style: standard