Skip to content

Commit

Permalink
Add development environment issue template
Browse files Browse the repository at this point in the history
And stub architecture documentation.
  • Loading branch information
seanh committed Aug 8, 2022
1 parent 190488f commit b79aca3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/03_development_environment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: 03. Development environment set up
about: Tasks for a new engineer to set up their development environment
title: <@username> Development Environment Set Up
labels: ''
assignees: ''

---

- [ ] **Engineer**: read our [high-level architecture overview](/docs/architecture.md)
- [ ] **Engineer**: set up your local development environment and get everything working locally.
Follow [our guide](/docs/DEVELOPING.md)
- [ ] **Buddy**: schedule a call with the engineer to check-in and answer any questions they have
- [ ] **Engineer**: check off this item once you've had the check-in with your buddy
7 changes: 7 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Hypothesis Architecture Overview
================================

This file is intended to one day contain a basic high-level overview of
Hypothesis's system architecture (see https://github.com/hypothesis/onboarding/issues/16).
For now [Nick's H Architecture Talk](https://docs.google.com/document/d/1saDTLAniQiwV3KlUE7imo1ZP2BVSVEOQm_yfbKbCKn4/)
from 2017 is the best we have.

0 comments on commit b79aca3

Please sign in to comment.