forked from torrust/torrust-index
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add adr for lowercase infohashes
- Loading branch information
1 parent
556306a
commit 07943f1
Showing
2 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Lowercase infohashes | ||
|
||
## Description | ||
|
||
We use both uppercase and lowercase infohashes. This is a problem because | ||
we have to check both cases. For example, we have to convert to uppercase before | ||
inserting into the database or querying the database. | ||
|
||
The database and API URLs use uppercase infohashes, and they are case-sensitive. | ||
|
||
## Agreement | ||
|
||
We agree on use lowercase infohashes everywhere and try to convert then as soon | ||
as possible from the input. | ||
|
||
There is no specific reason to use lowercase infohashes, but we have to choose | ||
one of them. We decided to use lowercase because the infohash is a hash, and | ||
hashes are usually lowercase. | ||
|
||
We will change them progressively. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Architectural Decision Records (ADRs) | ||
|
||
This directory contains the architectural decision records (ADRs) for the | ||
project. ADRs are a way to document the architectural decisions made in the | ||
project. | ||
|
||
More info: <https://adr.github.io/>. | ||
|
||
## How to add a new record | ||
|
||
For the prefix: | ||
|
||
```s | ||
date -u +"%Y%m%d%H%M%S" | ||
``` | ||
|
||
Then you can create a new markdown file with the following format: | ||
|
||
```s | ||
20230510152112_title.md | ||
``` | ||
|
||
For the time being, we are not following any specific template. |