Skip to content

Commit e9cacc6

Browse files
committed
docs(developer-guide): update instructions
1. README 2. ADR workflow 3. API guidelines GH-5
1 parent 54647b3 commit e9cacc6

File tree

4 files changed

+363
-47
lines changed

4 files changed

+363
-47
lines changed

docs/adr/0001-record-architecture-decisions.md

+2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ We need to record the architectural decisions made on this project, since:
2626

2727
We will document every architecture-level decision for `getting-started-inner-source` and its core modules with an [Architecture Decision Record][nygard-article-url]. These are a well structured, relatively lightweight way to capture architectural proposals. They can serve as an artifact for discussion, and remain as an enduring record of the context and motivation of past decisions.
2828

29+
### Architecture decision workflow
30+
2931
The workflow will be:
3032

3133
1. A community member creates an ADR document outlining an approach for a particular question or problem. The ADR has an initial status of "proposed."

docs/developer-guide/README.md

+17
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
> <img align="bottom" alt="code" height="50" width="50" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/code.svg"> This guide is for those who want to contribute code to `getting-started-inner-source`. This guide describes how to set up your development environment so that you can build and test `getting-started-inner-source`.
44
5+
## Table of contents
6+
7+
<!-- toc -->
8+
9+
- [1. Recommended skills](#1-recommended-skills)
10+
- [2. Development software](#2-development-software)
11+
- [3. Getting the source code](#3-getting-the-source-code)
12+
- [4. Installing dependencies](#4-installing-dependencies)
13+
- [5. Building](#5-building)
14+
- [6. Running tests](#6-running-tests)
15+
- [7. Source code style guidelines](#7-source-code-style-guidelines)
16+
- [8. DevSecOps](#8-devsecops)
17+
18+
<!-- tocstop -->
19+
20+
<!-- tocend -->
21+
522
## 1. Recommended skills
623

724
In order to work with `getting-started-inner-source` as a developer, we recommend you:

0 commit comments

Comments
 (0)