C2LC-302: Initial pass at creating "docs" directory.

Metadata

Source
C2LC-302
Type
Task
Priority
N/A
Status
Done
Resolution
N/A
Assignee
N/A
Reporter
Created
2021-02-04T03:49:32.663-0500
Updated
2021-10-28T10:33:28.359-0400
Versions
N/A
Fixed Versions
  1. Coding Env 1.0
Component
N/A

Description

We have started meeting to discuss our architecture (and I would also say our technical governance). To support this effort, we agreed that I would restructure and lightly expand the existing documents we have such as CONTRIBUTE.md. These would be moved to a new docs directory.

In this directory would be guidance about the technologies we use, code conventions, contribution guidelines, et cetera. We also discussed making a place to record key architectural decisions, which would be structured as Architectural Decision Records, or "ADRs". These would live in docs/adr. Simon proposed naming ADRs in the order they are created, with three digits for starters. Although I would not create an ADR as part of this initial work, I would make the ADR directory along with a README.md explaining the concept in light detail.