Skip to content

Documentation for the MSDV GitHub workflow and some code for demos.

Notifications You must be signed in to change notification settings

visualizedata/github-workflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 

Repository files navigation

github-workflow

Documentation for the MSDV GitHub workflow.

Workflow for contributing to visualizedata repositories

  1. Initial setup:

  2. In the local clone of your fork, create a branch for your edits.
    git branch mybranch creates a branch named mybranch
    git checkout mybranch switches to the branch mybranch

    • Do all your work in this branch.
    • Push your branch to the forked repo early and often.
    • Never work in the master branch!
  3. Pull in changes often from the upstream master to keep it synced so that when you prepare your pull request, merge conflicts will be less likely. Again, never work in the master branch!

  4. Merge the fork master into the fork branch and, if applicable, resolve any merge conflicts.
    git merge <branch> merges the specified branch into the current branch.

  5. When you are ready for your contributions to be considered, open a Pull Request in GitHub. The Pull Request should be for the up-to-date branch of your fork. Prior to submitting the Pull Request, make sure you have:

    • Synced the fork master with the latest version of the upstream master (#3).
    • Merged the fork master to the fork branch and resolved any merge conflicts (#4).

Tips

Use GitHub issues to log problems and communicate.

Sometimes, you mess up and need to go back to a previous commit. Use revert. Do not use reset! Here's a helpful Stack Overflow answer.

Helpful resources

About

Documentation for the MSDV GitHub workflow and some code for demos.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published