From 92d1ff38a7e62e9e467d201ee360b4232e0c8a4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maur=C3=ADcio=20Antunes?= Date: Tue, 23 Apr 2024 19:49:53 -0300 Subject: [PATCH] docs: Mention ADR --- README.md | 4 +++- {adr => docs/adr}/0001-data-storage-routing.md | 0 2 files changed, 3 insertions(+), 1 deletion(-) rename {adr => docs/adr}/0001-data-storage-routing.md (100%) diff --git a/README.md b/README.md index 909cf87..412a326 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ Feel free to contribute to this project by opening issues or pull requests. How could you contribute? -* Open an issue to report a bug or suggest a new feature; +* Opening an issue to report a bug or suggest a new feature; * Writing new features; * Covering the code with tests; * Improving the code quality; @@ -96,6 +96,8 @@ How could you contribute? If you want to contribute, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file. +For more **advanced** contributions, please, create an issue to discuss the feature you want to implement. If it is a complex decision or a big feature, it is better to create an ADR (Architecture Decision Record) to write down the decision and the reasons behind it. Check the [adr](docs/adr) folder for more information. + ## Roadmap - [ ] Video and audio transcoding (profiles) diff --git a/adr/0001-data-storage-routing.md b/docs/adr/0001-data-storage-routing.md similarity index 100% rename from adr/0001-data-storage-routing.md rename to docs/adr/0001-data-storage-routing.md