Skip to content
This repository was archived by the owner on Feb 19, 2024. It is now read-only.

Commit e4c0ff4

Browse files
committed
docs(adr): add ADRs
They have been removed from the docs: NordicSemiconductor/asset-tracker-cloud-docs@1db3320
1 parent 0014f4a commit e4c0ff4

5 files changed

+54
-0
lines changed

adr/002-use-npm-package-registry.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ADR 002: Use NPM registry
2+
3+
In March 2020,
4+
[GitHub acquired NPM](https://github.blog/2020-03-16-npm-is-joining-github/) and
5+
it will be kept operational as a registry for public JavaScript packages. So, as
6+
of now, the packages can be moved back to NPM.
7+
8+
This supersedes
9+
[ADR 001: Use GitHub package registry](https://github.com/NordicSemiconductor/asset-tracker-cloud-docs/blob/d14e0e0ec692bea5e3b1ea0b50b359c0dc8c0c4f/docs/adr/001-use-github-package-registry.md).
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# ADR 003: Use saga as the name for the main branch
2+
3+
Historically, Git and other software use terms such as `master/slave`,
4+
`whitelist/blacklist`, which are based on racial concepts. Their continued use
5+
maintains the racial stereotypes they depict. Better alternatives in meaning and
6+
technical correctness exist, like `leader/follower`, `blocklist/allowlist`.
7+
8+
In the Nordic mythology, a `saga` is a long, continuous recollection of stories
9+
about the history of humans, legends, and Gods. The term `saga` reflects very
10+
well what happens in a Git repository. Changes happen in branches (some teams
11+
tie them to _User Stories_, which are sometimes directly or loosely coupled to
12+
the main branch). Once the changes are finalized, they get added to the main
13+
branch, or get appended in the case of a rebase. The mental model of a big book
14+
of stories fits this process very well.
15+
16+
Therefore, the main branch in this project is named `saga`. `master` must not be
17+
used.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ADR 004: Move to Nordic Semiconductor GitHub organization
2+
3+
In February 2021, the project was moved from the `Bifravst` GitHub organization
4+
to the official Nordic Semiconductor GitHub organization
5+
(`Nordic Semiconductor`). This move was caused by the
6+
[promotion of the Bifravst project into an official Nordic Semiconductor open-source project](https://github.com/bifravst/bifravst/issues/56)
7+
with the release of the firmware in
8+
[nRF Connect SDK](https://github.com/nrfconnect/sdk-nrf) as
9+
[nRF9160: Asset Tracker v2](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.5.0/nrf/applications/asset_tracker_v2/README.html)
10+
application.
11+
12+
The project is renamed to _nRF Asset Tracker_.

adr/005-clean-gitignore.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ADR 005: Clean `.gitignore` file
2+
3+
A `.gitignore` file in a project must only cover the artifacts caused by the
4+
contained source code and not those caused by the personal choice of editor or
5+
the environment of a developer.
6+
7+
This is explained in detail
8+
[here](https://github.com/coderbyheart/first-principles/issues/30).

adr/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Architecture decision records
2+
3+
This folder contains the architecture decision records (ADRs) for this project.
4+
5+
To know more about ADRs, see
6+
[Documenting architecture decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)
7+
and the video on
8+
[Communicating and documenting architectural decisions](https://www.youtube.com/watch?v=rwfXkSjFhzc).

0 commit comments

Comments
 (0)