Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 3.5 KB

HOW_TO_CONTRIBUTE_UPDATES.md

File metadata and controls

75 lines (50 loc) · 3.5 KB

How to contribute updates to this repository

It is recommended to follow the best practices detailed in the MS Data Visualization GitHub workflow document found at https://github.com/visualizedata/github-workflow

Please be mindful of keeping your project links active. Please submit a pull request with your new project URL if you relocate your work to a different domain name or hosting provider.

Project data is stored in the ./data/data.json file.

The JSON object contains two arrays: "projects" and "students"

Projects follow this template:

{
  "title": "A Nice Title",
  "title_full": "A Nice Title: Additional Subtitle Text",
  "description": "",
  "url": "https://<URL TO PROJECT>",
  "author": "Student Name",
  "image": "<IMG FILE NAME>.jpg"
}

Author fields should have an exact text match to an entry in the students array. Image urls are relative to the ./data/images/ folder.

Student entries follow this template:

{
  "name": "Student Name",
  "url": "<STUDENT PERSONAL URL>"
}

Workflow for contributing to MS Data Visualization 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