Skip to content

Collaboration Plan

As a team, we are believers in reproducible, version-controlled work wherever possible. However, Git does not work like GoogleDocs and synchronous editing of the same file(s) is not the recommended way of engaging with Git/GitHub anyway. See the instructions below for how we've decided to work together as a team.

Team-Member Guidelines

  1. Follow Git best practice: commit often, include clear and concise commit messages, pull/push frequently, and communicate with the group on what/when you are editing
  2. Feel free to edit scripts in our GitHub repositories*, whether or not you are the original author
    • * = if the repository supports a website, please make a branch and submit a pull request instead of editing directly in main
    • If desired, you can also work in a personal script in the sandbox/ folder and then ask someone else in the group to integrate your work with others' if/when that is needed
  3. Use GitHub Issues to track or assign tasks and documentation
    • Consider filling out the "metadata" in the right sidebar of the issue so that it is contextually-rich and useful to other teammembers

External Guidelines

We are so flattered that you've found our group's work and want to weigh in! Please open a GitHub issue on the relevant repository outlining your specific suggestion/question/comment and someone will be in touch with you shortly.

If it is relevant, please attach a reproducible example or screen capture (with useful alt text) to that issue.