Skip to content
This repository has been archived by the owner on Jan 25, 2020. It is now read-only.
Jonathan Pascoe edited this page May 5, 2019 · 19 revisions

NOTE: THIS IS A PUBLIC REPOSITORY - NO PASSWORDS OR SENSITIVE INFORMATION

This is a one-stop place to find all documentation and information about TJI. It's a work in progress, and currently focuses more on technical components of our work, but it's a living document that should perpetually evolve.

Website Workflow

  • The TJI website is a technical product like any other.
  • Every developer who changes code must have another developer review it before merging with master. This is an industry-standard software development practice. When using git and github, this is done by putting your work on a separate branch, pushing that branch to github, and creating a pull request. You then assign one or more reviewers to comment, go back and forth to make changes until reviewers are satisfied (they click "approve"), and only then merge with the master branch.
  • Every task (technical or not) to be accomplished should be represented in a github issue. You can make an issue for anything -- even vague, long-term wishes that we may never get to -- though most of the time an issue will be a concrete task for a single person to knock out. Please only work on issues you are assigned to/assign yourself to. If you do tweak someone else's issue, please make tweaks to their branch and let them know.
  • Generally, our work is organized in milestones, which is basically a plan to release X, Y, and Z things on D date. Issues can be added to milestones (see right hand panel on any issue's page), then we can just look at the milestone and see all the work we plan to get done by D date.

Weekly meetings

  • A github Issue should be created for each weekly meeting for people to write items they'd like to discuss. This issue should have the meeting agenda label attached.
  • We should also discuss each new github issue that has been created since the last meeting. If it makes sense, we'll add it to a milestone and assign a person to work on it.

Resources for TJI website developers

Styling

Our many tools