-
Development
Development The development.md is a good chance to give an deep dive into all the tricks, quirks, and tips of working with the service. A few other things that may be helpful to capture in the development.md: * setting up the environment for M1/M2 vs Intel * useful settings in the IDE for working with the repo * debugging…
-
Overview
Overview The overview.md doc should aim to capture a brief description of the service so new contributors can quickly get a sense of what this service does, why it matters, and any other useful facts to get at a glance. A good example of a useful overview.md comes from the iam project: Node.js service for handling…
-
Layout
Layout The layout.md document aims to describe the layout of the repo and overall general architecture of the service for new contributors. As this document was created from a template, it is up to the service owner to create a valuable layout.md. Some useful information to capture in a layout.md may include the following:…
-
Quickstart
Quickstart A quickstart.md is useful to users who may need to bring up the service as a dependency to something else, or someone who needs to quickly bring up the service to validate a recent change. A quickstart.md should aim to capture the minimal steps to get an environment up and running along with any first time setup…
