Skip to content

Commit 07943f1

Browse files
committed
docs: add adr for lowercase infohashes
1 parent 556306a commit 07943f1

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Lowercase infohashes
2+
3+
## Description
4+
5+
We use both uppercase and lowercase infohashes. This is a problem because
6+
we have to check both cases. For example, we have to convert to uppercase before
7+
inserting into the database or querying the database.
8+
9+
The database and API URLs use uppercase infohashes, and they are case-sensitive.
10+
11+
## Agreement
12+
13+
We agree on use lowercase infohashes everywhere and try to convert then as soon
14+
as possible from the input.
15+
16+
There is no specific reason to use lowercase infohashes, but we have to choose
17+
one of them. We decided to use lowercase because the infohash is a hash, and
18+
hashes are usually lowercase.
19+
20+
We will change them progressively.

adrs/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Architectural Decision Records (ADRs)
2+
3+
This directory contains the architectural decision records (ADRs) for the
4+
project. ADRs are a way to document the architectural decisions made in the
5+
project.
6+
7+
More info: <https://adr.github.io/>.
8+
9+
## How to add a new record
10+
11+
For the prefix:
12+
13+
```s
14+
date -u +"%Y%m%d%H%M%S"
15+
```
16+
17+
Then you can create a new markdown file with the following format:
18+
19+
```s
20+
20230510152112_title.md
21+
```
22+
23+
For the time being, we are not following any specific template.

0 commit comments

Comments
 (0)