Skip to content

Latest commit

 

History

History
96 lines (60 loc) · 4 KB

CONTRIBUTING.md

File metadata and controls

96 lines (60 loc) · 4 KB

Contributing

Hi Stackies! In order for you to add your resolution please Add yourself to the list of stackies in Alphabetical Order along with your first pull request.

This document lays out how to get you started in contributing, so please read carefully and throughly.

If you have any concerns or the steps are unclarified to you, you can approach your concern in the discussions.

Steps

  1. Fork this project

Click the fork button on the repo at https://github.com/AbbeyIT/Stackie-2023-resolution

  1. Clone your forked version

Your repo will now be in your GitHub. Clone the repo to your computer with the following command:

git clone https://github.com/<YOUR-GITHUB-USERNAME>/Stackie-2023-resolution.git
  1. Switch to the cloned folder.
cd Stackie-2023-resolution
  1. Create a branch

Branch away from the main branch and use the following schema for naming your branches:

git checkout -b <ANY-NAME>
  1. Make changes
  • Open STACKIES.md file.
  • Add your details to the table with your name, github handle, and your resolution.
  • Make sure to add your name in Alphabetical Order.

Example Format

| [Name](GitHub-Link)                | Resolution                 |
| [Abbey](https://github.com/AbbeyIT) | To focus on my health more |
  1. Staged your commit.

Add your changes to the STACKIES.md file with the following command:

git add STACKIES.md
  1. Commit your changes (write a short descriptive message of what you have done)
git commit -m "add <yourname> to Stackies"

If you are not sure how to make a good commit message, please read here.

  1. Push your changes to your forked version

Push your changes, use your branch name you created above

git push origin <BRANCH-NAME>
  1. Go to the original project on GitHub & Create a Pull Request

You now will get a link in the terminal to create the pull request you can go to that link or go into your forked repo and create the pull request.

  • On the GitHub website, navigate to your forked repo - on the top of the files section, you'll notice a new section containing a Compare & Pull Request button.

  • Click on that button, this will load a new page, comparing the local branch in your forked repository against the main branch in the Stackie 2023 resolution repository. Fill up the necessary details there and click the green Create Pull Request button.

  • Your pull request will be reviewed and then eventually merged.

How can I fix a merge conflict?

A GitHub conflict is when people make changes to the same area or line in a file. This must be fixed before it is merged to prevent collision in the main branch.

Congratulations! 🥳

You have now created your first pull request to this repo and have your first contribution. On to more green squares! 🟩