From a677a58c2cce471947fa6c1a40340dbcb76c7e81 Mon Sep 17 00:00:00 2001 From: Ikko Eltociear Ashimine Date: Sun, 28 Jul 2024 00:44:34 +0900 Subject: [PATCH] docs: update README.md readablity -> readability --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e837bf2..54ef6ce 100755 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ The core idea of stocknear shall always be: ***Fast*** & ***Simple***. If want to contribute to the codebase please follow these guidelines: - Refactoring slow code into fast code is a huge plus! - Reducing complexity and increasing simplicity/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 maintainablity and readablity. +- 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 maintainablity and readability. - 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 ❤️