Skip to content

Commit

Permalink
Add documented support of adr-tools-python 1.0.4b0
Browse files Browse the repository at this point in the history
As this is the latest (albeit beta) version available, based on [1]
currently. This tool is being referred to by [2] among other references.

Introduce this tool to enable potential (yet likely) upcoming ADRs [2]
that are reviewable, as a mean to replace design documents such as [3].

Document everything added now using the existing ./README.md. Initialize
the ./doc/adr folder structure with initial ADR #1 using 'adr-init'.

Add the default Python virtual-env steps in README. Base these on what
the sibling repositories [4] and [5] currently have.

[1] https://pypi.org/project/adr-tools-python/#history
[2] https://adr.github.io
[3] https://wiki.eclipse.org/Trace_Compass/Design_Documents
[4] https://github.com/theia-ide/trace-server-protocol#setup
[5] https://github.com/theia-ide/tsp-python-client#setup

Signed-off-by: Marco Miller <marco.miller@ericsson.com>
  • Loading branch information
marco-miller committed Feb 8, 2022
1 parent f57edb9 commit b4f9bad
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
*.log
*.tsbuildinfo
.browser_modules/
/.venv/
/packages/react-components/coverage/
TraceCompassTutorialTraces
TraceCompassTutorialTraces.tgz
Expand Down
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,3 +334,31 @@ The following command prints a coverage report to the terminal. As of now, it co
```bash
yarn test --coverage --collectCoverageFrom='src/**/*.ts'
```

## About ADRs

ADRs are [Architectural Decision Records][adr].

* The `./doc/adr` directory was initialized using `adr-init` based on [adr-tools-python][tools].
* The `adr-new` command (from [adr-tools-python][tools]) is used to add new ADRs further.
* That tool can be installed locally (only once) using [the instructions below](#python-setup).
* The latter also shows how to activate a Python virtual environment to locally run commands.
* These aforementioned `adr-` commands are [meant to be executed from this root directory][tools].
* ADRs should be preferred to [design documents][docs] for their structure and reviewability.

### Python setup

To initialize a local virtual environment, type the following commands in the root directory:

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
````

* The virtual environment can be replaced with another setup locally.
* Above, the `./requirements.txt` file has [the ADR tool][tools] to install.

[adr]: https://adr.github.io
[docs]: https://wiki.eclipse.org/Trace_Compass/Design_Documents
[tools]: https://pypi.org/project/adr-tools-python/
19 changes: 19 additions & 0 deletions doc/adr/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 1. Record architecture decisions

Date: 2022-01-27

## Status

Accepted

## Context

The issue motivating this decision, and any context that influences or constrains the decision.

## Decision

The change that we're proposing or have agreed to implement.

## Consequences

What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
adr-tools-python == 1.0.4b0

0 comments on commit b4f9bad

Please sign in to comment.