search

MichaelPachec0 / nodejs-project-night

Project night for May 27 2022
MIT License
5 stars 12 forks source link

Instructions for commiting #3

Open MichaelPachec0 opened 2 years ago

MichaelPachec0 commented 2 years ago

Create Instructions for a workflow in read-me (or another file), the rough idea is

  1. Fork this repository to your account (done in GitHub)
  2. Clone from your repository url ( git clone \<forked repository url>)
  3. Make a branch to work on the code (ideally name it based on what you are trying to contribute, like "add license" or "front end") (git checkout -b \<branch name> master)
  4. Make changes & add the changes to the staging area.
  5. Commit changes to that branch git. (git commit)
  6. Push said changes to your GitHub repository (git push)
  7. When are ready to contribute back to the main repository then send a pull request to my repositories master branch (on GitHub)
  8. Once that gets merged then fetch and merge from your GitHub master branch (on your repository in GitHub). You also can delete the branch that the PR was used for (not needed anymore since the commits are already in the master branch).
  9. Pull new changes locally (git pull)
  10. If you want to commit another set of changes, after updating your local master branch follow 3 on.
MichaelPachec0 commented 2 years ago

I will probably take this but i would like feedback from group members on the Instructions currently posted here.

JoeDravarol commented 2 years ago

We've decided to put the contributing instructions into CONTRIBUTING.md to keep the current README file short and concise. So if anyone want to learn how to contribute to the repository they will go to CONTRIBUTING.md to read the instructions.

JoeDravarol commented 2 years ago

It would be nice if there was a short video/gif displayed to show new people how to do a pull request.

PR Gif