From 376e968afd67a5ff512b70e93cc2789743f74c21 Mon Sep 17 00:00:00 2001 From: Muslem Rahimi Date: Sun, 7 Jul 2024 22:44:09 +0200 Subject: [PATCH] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ab56eb1..12789177 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,11 @@ Coming soon to run stocknear locally on your machine. # Contributing Stocknear is open-source software and you're welcome to contribute to its development. -The core idea of stocknear shall always be: ***Simplicity***, ***Maintainable***, ***Readable*** & ***Fast*** in this order. +The core idea of stocknear shall always be: ***Fast*** & ***Simple***. If want to contribute to the codebase please follow these guidelines: -- Reducing complexity and increasing readability is a huge plus! -- Anything you claim is a "speedup" must be benchmarked. In general, the goal is simplicity, so even if your PR makes things marginally faster, you have to consider the tradeoff with maintainability and readability. +- Refactoring slow code into fast code is a huge plus! +- Reducing complexity and increasing simplicity/readability is a huge plus! - If your PR looks "complex", is a big diff, or adds lots of lines, it won't be reviewed or merged. Consider breaking it up into smaller PRs that are individually clear wins. A common pattern I see is prerequisite refactors before adding new functionality. If you can (cleanly) refactor to the point that the feature is a 3 line change, this is great, and something easy for us to review. # Support ❤️