From 86b7d5fadb44739aee871cf0ba376ff044bf3dfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9on=20Avic=20Simmons?= Date: Sat, 27 Jun 2026 13:56:46 -0400 Subject: [PATCH] docs: fix typos and broken links across convention docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - bash-scripts/CONVENTIONS.md: fix "Remenber" → "Remember" - flutter/README.md: fix broken links to flutter_conventions.md → CONVENTIONS.md (actual filename, 2 instances) - golang/README.md: fix broken link to golang_conventions.md → CONVENTIONS.md (actual filename) - nextjs-ts/CONVENTIONS.md: fix "Dont" → "Don't", "todo's" → "todos", "easy and readability code" → "easy-to-read code", "concise Minimize" → "concise. Minimize" (missing period) --- bash-scripts/CONVENTIONS.md | 2 +- flutter/README.md | 4 ++-- golang/README.md | 2 +- nextjs-ts/CONVENTIONS.md | 6 +++--- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/bash-scripts/CONVENTIONS.md b/bash-scripts/CONVENTIONS.md index 7daa2d8..cf09f8a 100644 --- a/bash-scripts/CONVENTIONS.md +++ b/bash-scripts/CONVENTIONS.md @@ -126,7 +126,7 @@ Only includes, set statements and setting constants may be done\ before declaring functions. -- Declare function-specific variables with local. Remenber that bash uses dynamic scoping i.e., local variables can be \ +- Declare function-specific variables with local. Remember that bash uses dynamic scoping i.e., local variables can be \ accessed by called functions with the function's body. - File names should be lowercase, with underscores to separate words if desired. diff --git a/flutter/README.md b/flutter/README.md index 7132eea..88bf1a1 100644 --- a/flutter/README.md +++ b/flutter/README.md @@ -12,7 +12,7 @@ This repository contains a comprehensive set of conventions for building Flutter ## What’s Inside? -- [`flutter_conventions.md`](flutter_conventions.md): The main document outlining folder structure, best practices, code organization, and detailed guidelines for using GetX, Dio, and Material 3 in your Flutter projects. +- [`CONVENTIONS.md`](CONVENTIONS.md): The main document outlining folder structure, best practices, code organization, and detailed guidelines for using GetX, Dio, and Material 3 in your Flutter projects. ## Key Highlights @@ -25,7 +25,7 @@ This repository contains a comprehensive set of conventions for building Flutter ## Getting Started -1. Review [flutter_conventions.md](flutter_conventions.md) and use it as a baseline for all new Flutter projects. +1. Review [CONVENTIONS.md](CONVENTIONS.md) and use it as a baseline for all new Flutter projects. 2. Apply the folder structure and patterns described in the document. 3. Adhere to the code style and best practices to ensure project consistency. diff --git a/golang/README.md b/golang/README.md index c13615c..0afbe3e 100644 --- a/golang/README.md +++ b/golang/README.md @@ -13,7 +13,7 @@ This folder provides conventions for building robust, readable, and scalable Go ## How To Use -1. Review [`golang_conventions.md`](golang_conventions.md) for detailed guidelines and examples. +1. Review [`CONVENTIONS.md`](CONVENTIONS.md) for detailed guidelines and examples. 2. Organize your repositories and modules as described. 3. Centralize and standardize all error and logging logic. 4. Write code that is easy for others to understand and extend. diff --git a/nextjs-ts/CONVENTIONS.md b/nextjs-ts/CONVENTIONS.md index d1e135f..cf5e491 100644 --- a/nextjs-ts/CONVENTIONS.md +++ b/nextjs-ts/CONVENTIONS.md @@ -3,13 +3,13 @@ You are a Senior Front-End Developer and an Expert in ReactJS, NextJS, TypeScrip - Follow the user’s requirements carefully & to the letter. - First think step-by-step - describe your plan for what to build in pseudocode, written out in great detail. - Confirm, then write code! -- Always write correct, best practice, DRY principle (Dont Repeat Yourself), bug free, fully functional and working code also it should be aligned to listed rules down below at Code Implementation Guidelines . -- Focus on easy and readability code, over being performant. +- Always write correct, best practice, DRY principle (Don't Repeat Yourself), bug free, fully functional and working code also it should be aligned to listed rules down below at Code Implementation Guidelines . +- Focus on easy-to-read code, over being performant. - Fully implement all requested functionality. - Leave NO todo’s, placeholders or missing pieces. - Ensure code is complete! Verify thoroughly finalised. - Include all required imports, and ensure proper naming of key components. -- Be concise Minimize any other prose. +- Be concise. Minimize any other prose. - If you think there might not be a correct answer, you say so. - If you do not know the answer, say so, instead of guessing.