Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

1. Safe Places Dev Overview

<Placeholder>

2. Contribution Guidelines

2.1 Git Repos and branch reference

...

Repo

...

URL

...

Branch

...

Description

...

Staging Server

...

Safe Places Front End

...

path-check/safeplaces-frontend

...

master

...

Latest production code

...

https://safeplaces.extremesolution.com

...

dev

...

Latest development code

...

https://react.safeplaces.extremesolution.com

...

Safe Places Back End

...

path-check/safeplaces-backend

...

master

...

Latest production code

...

http://api.express.safeplaces.extremesolution.com

...

dev

...

Latest development code

2.2 Code Submission Etiquette

  • Devs should associate work with a git issue

  • If issue exists, tech lead may assign it to a dev

  • If issues does not exist, dev create create issue and self-assign

  • Tech lead + PMs will categorize issues against Jira stories

2.3 Community Roles

Role

Responsibilities

Requirement

Privileges

Defined by

Member

Active contributor

Has multi contributions

Sponsored by 2 reviewers

Have issues and PRs assigned to them

Participate in SIGs through GitHub teams

Safe Places GitHub org member

Reviewer

Review PRs and proposals

History of review and authorship in an area

Review code for quality and correctness on some part of the project

OWNERS file reviewer entry

Approver

Approve PRs and proposals

Highly experienced and active reviewer and contributor to an area

Both review and approve code contributions

OWNERS file approver entry

Maintainer

Manage and control project permissions and health

Highly experienced contributor active in multiple areas and roles

GitHub path-check/repos write access

Maintainers team in GitHub org

3. Meetings and Communication Channels

3.1 Meetings

Meeting

Dates / Times

Agenda

Front End Dev

  • Every Monday, Wednesday

  • 7am PST

  • New Joiner Intros

  • Scrum updates

  • Rolling agenda items

Back End Dev

  • Every Tuesday, Thursday

  • 7am PST

  • New Joiner Intros

  • Scrum updates

  • Rolling agenda items

All-hands

  • Every Friday

  • 7am PST

  • Product Discussion

  • Guest topic from PM + other teams

  • “Social un-distancing”

3.2 Slack

3.3 Mailing List

ML Membership is self-managed - https://groups.google.com/forum/#!myforums

4. Jira Project Management

4.1 Jira Projects

https://pathcheck.atlassian.net/secure/RapidBoard.jspa?rapidView=3&projectKey=PLACES

4.2 Jira terminology

  • Stories -

  • Issues -

  • Epics -

5. Documents

5.1 Organizational Documents

5.2 Product Documents

5.3 Technical Documents

  • React Component Documentation (TBD)

  • Backend Database schema (TBD)