| Info |
|---|
Note: Work in progress |
| Table of Contents |
|---|
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 | Latest production code | |||
Latest development code | ||||
Safe Places Back End | Latest production code | |||
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 |
|
|
Back End Dev |
|
|
All-hands |
|
|
3.2 Slack
Developers - #scrum_team_safe_places
QA - #safeplaces_testing
3.3 Mailing List
Front End Dev - safe-places-fe@googlegroups.com
Back End Dev - safe-places-be@googlegroups.com
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)