Starter Hive ✨

This project aims to simplify and guide the way beginners make their first contribution.

Table of Content

• Contributing
• Contributors
• License

Contributing

Following are the steps to guide you:

Step 1

• Fork this repository

Step 2:

• Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

The code will look something like this :

git clone https://github.com/{your user name}/StarterHive.git

Step 3:

• Navigate to StarterHive on your device

cd StaterHive/

Step 4:

• Add an upstream link to the main branch in your cloned repo

  git remote add upstream https://github.com/ArslanYM/StarterHive
  

• Keep your cloned repo up to date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)

  git pull upstream main
  

Step 5:

• Create your feature branch (This is a necessary step, so don't skip it)

  git checkout -b <feature-name>
  

Step 6: Make necessary changes and commit those changes

• Add your commits to the staging

  git add .
  

Step 7: Commit the changes

• Now commit those changes using the git commit command:

  git commit -m "Write a meaningful but small commit message"
  

• Follow this Guide for commit messages.

Step 8: Push your code.

• Push your changes using the command git push :

  git push -u origin your-branch-name
  

Step 9:

• Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

New to open-source?

You can also contribute to this project if you are new to open source:

• Check out the CONTRIBUTORS.md file to get started

Contributors

Thank you for your dedication and hard work. Your contributions are invaluable to our team, and we are so grateful for all that you do. Your hard work and dedication is truly admirable. Thank you for your unwavering commitment and for all that you do for our team.

Please visit Contributors to check the list of contributors and add your name to the list to become a contributor.

Guidelines

Make sure you are following the Guidelines of this project while contributing. Take a look at Guidelines.

License

Starter Hive is licensed under the MIT License. See the LICENSE file for more information.