Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 2.89 KB

project_contributions.md.md

File metadata and controls

96 lines (61 loc) · 2.89 KB

Profile Contributions Guidline

Feel Free to look through any the project for your own use! If you have any questions or need any explanation just ask! Dont Hesitate to:

  • Report a bug
  • Submit a fix
  • Propose new features

(I will get back to you as soon as I can to assign!)

*** Any and all negitivity will be rejected from my profile. Be postivie with your words, vibes, and criticism! ***

Contribute with Ease

Follow these steps to start contributing on any known issues:

1. If you want to work on issue then comment, and get assigned or are using for your own personal portfolio Fork this repository.

2. Clone your forked copy of the project.

git clone <Forked Repository>

3. Navigate to the project's directory and open it in your code editor. 📁 .

cd JesseGreenoughPortfolio

4. Install all project dependencies

npm i/npm install or yarn install

5. Add a reference(remote) to the original (not forked) repository ALWAYS UPSTREAM.

git remote add upstream <Original Repository Name>

6. Check the remotes for this repository.

git remote -v

7. Pull from the upstream repository to your branch to keep it at par with the main project branch(for any repository updates).

git pull upstream main

8. Create a new branch.

git checkout -b <your_branch_name>

9. Track your changes.

git add . 

10. Get your application running locally

11. Perform your desired changes to the code base.

12. Commit your changes .

git commit -m "__Insert Commit Message__"

13. Push the committed changes for your feature to your branch at the forked repo.

git push -u origin <your_branch_name>

14. Open a Pull Request with a name of the issue, photo(s), and description of your changes with reasons. To create a pull request, click on compare and pull requests. Please ensure you compare the branch with your featured update to the main branch of the repository in question.

15. Add appropriate title, description and image to your pull request explaining/showing your changes and efforts done.

16. Click on Create Pull Request.

All Done! You have made a PR.

P.S. You could also do all of the git commands easier with the use of gitKraken

Thank you for your contributions!

Big Thanks to Sanket1308 for the Contributing Template provided.