[GODRIVER-399] Technical Contributor Documentation and Architecture Guide Created: 01/May/18  Updated: 24/Jul/20  Resolved: 24/Jul/20

Status: Closed
Project: Go Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: None

Type: New Feature Priority: Major - P3
Reporter: Sam Kleinman (Inactive) Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends

 Description   

As a new contributor to the driver I've often found myself confused about the architecture of the driver, what the goals, beliefs, and directions that you expect the driver to take. There's so much context shared between developers about Go, MongoDB, and the history of the project, that it's not always obvious why some decisions were made. 

Without this kind of background I found it easy to get lost in detail, or miss the obvious solution. In addition to explaining the components of the system and an overview of their current state, it would also be useful to add some aspirational content about the direction that we want to take the driver, higher level goals, and areas of focus for the next ~year.

Having a really strong developer's guide will also help ease the cost of onboarding new contributors


Generated at Thu Feb 08 08:34:07 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.