Skip to content

docs: add decision log #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add decision log #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8299e62
docs: add decision log
simonsan Sep 18, 2024
5da6869
remove c&p
simonsan Sep 18, 2024
5754054
fmt: dprint
simonsan Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
- [Requirements](./design/analysis/requirements.md)
- [Development](./development/intro.md)
- [Glossary](./development/glossary.md)
- [Decision Log](./development/decision_log.md)
- [Release process](./development/release_process.md)
- [Testing](./development/testing.md)
- [Talks](./talks.md)
Expand Down
12 changes: 12 additions & 0 deletions src/development/decision_log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Decision Log

This document contains a log of decisions made during the development within the
rustic ecosystem.

## 2024-09-16: Naming Conventions for Types

We will use the following naming conventions for the following types:

- Singular: `Type`, exactly one value, e.g. `path: Path`
- Plural: `Vec<Type>`, an array that may contain one or more values, e.g.
`paths: Vec<Path>`