Skip to content

Commit

Permalink
[MOB-3028] Remove Ecosia framework comments
Browse files Browse the repository at this point in the history
  • Loading branch information
d4r1091 committed Dec 20, 2024
1 parent 731b515 commit fd76165
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
14 changes: 13 additions & 1 deletion Ecosia/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# Ecosia Framework
# Ecosia framework

The Ecosia Framework aims to be a wrapper of all our Ecosia isolated implementation and logic.
Some of the Ecosia codebase still lives under the main project `Client/Ecosia` but the goal is to bring as much codebase as possible as part of this dedicated framework.

## Architectural Decision records

Architectural Decision Records (or ADRs) are a method of documenting important decisions a software team makes, and why the decisions were made. They are similar, but complementary to RFCs (requests for comment). The purpose of ADRs is to build up a terse and easily searchable log of decisions so future generations of engineers can understand why our systems are the way they are. For more information, see the [ADR site](https://adr.github.io).\
The are listed in numbered order in the [adr](Ecosia/Core/adr/) directory and should follow this [Y-statement-format](Ecosia/Core/adr/0_2021-04-27_Architectural-decision-record-template.md).

### Example

- [1_2021-04-27_File-based-user-data-persistence.md](Core/adr/1_2021-04-27_File-based-user-data-persistence.md)
- [2_2023-06-29_Environment_as_getter.md](Core/adr/2_2023-06-29_Environment_as_getter.md)
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,16 +246,4 @@ We built our snapshot testing setup with `SnapshotTestHelper` to streamline UI c
- **Comparison**: We capture snapshots of the UI and compare them to reference images to spot any unintended changes.
More details [here](SNAPSHOT_TESTING_WIKI.md)
## Ecosia framework
### Architectural Decision records
Architectural Decision Records (or ADRs) are a method of documenting important decisions a software team makes, and why the decisions were made. They are similar, but complementary to RFCs (requests for comment). The purpose of ADRs is to build up a terse and easily searchable log of decisions so future generations of engineers can understand why our systems are the way they are. For more information, see the [ADR site](https://adr.github.io).\
The are listed in numbered order in the [adr](Ecosia/Core/adr/) directory and should follow this [Y-statement-format](Ecosia/Core/adr/0_2021-04-27_Architectural-decision-record-template.md).
#### Example
- [1_2021-04-27_File-based-user-data-persistence.md](Ecosia/Core/adr/1_2021-04-27_File-based-user-data-persistence.md)
- [2_2023-06-29_Environment_as_getter.md](Ecosia/Core/adr/2_2023-06-29_Environment_as_getter.md)
More details [here](SNAPSHOT_TESTING_WIKI.md)

0 comments on commit fd76165

Please sign in to comment.