Skip to content

Home

Jump to bottom
Cyan edited this page Sep 17, 2021 · 16 revisions

Welcome, IMAGE Contributor!

An overall description of IMAGE can be found at IMAGE Project Public Website. This page is for those joining the project as contributors.

Project Board

The center point for working on IMAGE is our IMAGE Project Board, where we track all our work items and issues across multiple repositories. Guidelines:

  • Make issues specific and measurable so it is easy to determine whether it is complete (e.g., "work on x" can linger forever)
  • Never move an issue left in the project board without discussing with your lead and adding an @jeffbl comment
  • Scope issues to no more than 3 person-days of work OR add more granular checklist in description
  • We essentially use the Github flow tutorial model for development, more detail in the Github docs on pull requests/branching.

Development Resources

  • SRL repos beginning with atp-* are IMAGE repos. Each should be described on its homepage
  • Wiki pages (default in the server repo, if not repo-specific) cover things like the test/production servers, docker usage, etc.

McGill Internal Development

If you're on the McGill development team, we have some additional internal resources you'll need to sign up for. Ask @jeffbl for info.

  • For general SRL tools, e.g., group calendar, lab policies, etc., see the SRL internal wiki. Note that you will need to use the McGill VPN to get in.
  • We use Slack for quick communication, meeting reminders, etc. but please don't use it as a substitute for github issues.
  • In the Slack #general channel, there are pinned messages pointing to:
    • Google Drive, containing internal documentation related to funding, user studies, etc. Some documents you may want to scan when you first join:
      • StatementOfWork: what we've promised to the funder.
      • Quarter/Month Schedule: SoW broken out in more readable format, with added internal goals
      • Open Source Audit: Spreadsheet of open source components we use. Must be kept up-to-date, since this creates licensing and acknowledgement obligations.
      • Orgchart: An overview of how everyone fits together on the project
    • Password for internal section of public website, for installing extension, test pages, etc.
    • Times and online links to weekly meetings
  • Zotero library of relevant papers and articles
Clone this wiki locally