diff --git a/README.md b/README.md index b79ec7e..eb64e74 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,88 @@ This is a **systematic, multi-language DSA mastery repository**. - **Clean code standard** Clear naming, minimal cleverness, maintainable structure. +## Rrepository Structure + +``` +moltiful-algorithms/ +│ +├─ algorithms/ +│ ├─ arrays/ +│ ├─ dp/ +│ ├─ foundations/ +│ │ ├─ data-structures/ +│ │ ├─ graph-traversal/ +│ │ ├─ searching/ +│ │ ├─ sorting/ +│ │ └─ tecniques/ +│ └─ graphs/ +│ +├─ docs/ +│ └─ process/ +│ ├─ ... +│ ├─ definition-of-done.md +│ └─ definition-of-learnt.md +│ +├─ leetcode/ +│ ├─ arrays/ +│ │ ├─ 0001-two-sum.md +│ │ └─ ... +│ └─ ... +│ +├─ packages/ +│ ├─ js/ +│ └─ ts/ +│ +├─ py/ +│ +├─ ... +├─ package.json +├─ pnpm-workspace.yaml +└─ README.md +``` + +This is a monorepo, packages-first, test-driven. + +## Quality Gates + +Two explicit standards define completion: + +### Definition of Done + +A solution is considered “done” only if: + +- Tests pass +- Edge cases covered +- Complexity explained +- Code readable +- Invariant stated + +### Definition of Learnt + +A problem is considered “learnt” only if: + +- The core pattern is extracted +- The invariant is internalized +- Failure modes are understood +- The solution can be re-derived without looking + +## Data Structures + +- [Stack](algorithms/foundations/data-structures/stack.md) + +## Algorithms + +- **Sorting** + - [Merge Sort](algorithms/foundations/sorting/merge-sort.md) + ## How to use this repository +**Requirements** + +- Node 20+ +- pnpm 9+ +- Python 3.10+ + **Install all dependencies** ``` @@ -69,8 +149,6 @@ pnpm -C packages/js test pnpm -C packages/py test ``` - - ## Author -[@stemolti](https://stemolti.com) \ No newline at end of file +[@stemolti](https://stemolti.com)