Skip to content
Back to search

programming-best-practices

Awesome Programming Best Practices for Beginners

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/dereknguyen269--programing-best-practices/badge.svg)](/listings/dereknguyen269--programing-best-practices)

HTML

<a href="/listings/dereknguyen269--programing-best-practices"><img src="/api/listings/dereknguyen269--programing-best-practices/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

> Just browsing the guides? No setup needed β€” every link above works straight from GitHub. Follow these steps only for **offline access, local search, or AI-editor integration**.

βœ… Prerequisites

- **Git** (any recent version) - **Python 3.8+** with `pip` and `venv` (only needed for crawling, offline search, or installing the AI skill) - Works on macOS, Linux, and Windows (use `.venv\Scripts\activate` on Windows)

🎯 Automated Setup (Recommended)

The fastest way to get started is using our automated setup script:

# Clone the repository
git clone https://github.com/dereknguyen269/programing-best-practices.git
cd programing-best-practices

# Run the interactive setup script
./scripts/quick-start.sh

The script will guide you through different setup options:

| Mode | Time | What's Included | |------|------|-----------------| | **Minimal** | ~1 min | Dependencies only, no crawling | | **Test** | ~2-3 min | Dependencies + 20 sample resources | | **Full** | ~10-15 min | Everything + all 340+ resources + AI summaries | | **Custom** | Varies | Choose specific categories to crawl |

**Quick Options:**

# Minimal setup (just dependencies)
./scripts/quick-start.sh --minimal

# Full setup (everything)
./scripts/quick-start.sh --full

# Test with 20 resources
./scripts/quick-start.sh --limit 20

# Crawl only Python resources
./scripts/quick-start.sh --category python

πŸ“‹ Manual Setup (Alternative)

Prefer to set up manually? Follow these steps:

Step 1: Clone the Repository

git clone https://github.com/dereknguyen269/programing-best-practices.git
cd programing-best-practices

Step 2: Install Crawler Dependencies (Optional but Recommended)

The crawler downloads all external resources locally for offline access:

# Create virtual environment (recommended)
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies
pip install -r scripts/crawler/requirements.txt

Step 3: Crawl Resources (Optional)

Download all best practices content locally:

> **Note**: Make sure your virtual environment is activated before running these commands: > ```bash > source .venv/bin/activate # On Windows: .venv\Scripts\activate > ``` > > Or use the venv Python directly: `.venv/bin/python3` instead of `python3`

# Crawl all resources (~340+ links, takes 10-15 minutes)
python3 scripts/crawler/crawl.py

# Or crawl specific categories
python3 scripts/crawler/crawl.py --category python
python3 scripts/crawler/crawl.py --category javascript

# Or crawl a limited number for testing
python3 scripts/crawler/crawl.py --limit 20

# Update existing content
python3 scripts/crawler/crawl.py --update

Step 4: Generate AI Summaries (Optional)

Create condensed summaries optimized for AI assistants:

python3 scripts/crawler/generate_summaries.py

Step 5: Use with Your AI Coding Editor

The repository is now ready! Your AI coding editor will automatically detect:

| AI Editor | Config File | Auto-Detected | |-----------|-------------|---------------| | **Claude Code** | `skills/best-practices/` | βœ… | | **Kiro** | `.kiro/steering/best-practices/` | βœ… |

See [Searching the Knowledge Base](#-searching-the-knowledge-base) and [Troubleshooting](#️-troubleshooting) if you get stuck.

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json Β· Manifest Β· 38 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "name": "programming-best-practices",
  3. "owner": {
  4. "name": "Derek Nguyen",
  5. "email": "dereknguyen269@gmail.com"
  6. },
  7. "metadata": {
  8. "description": "Curated coding standards, style guides, and best practices across 30+ programming languages and frameworks",
  9. "version": "1.0.0",
  10. "pluginRoot": "./"
  11. },
  12. "plugins": [
  13. {
  14. "name": "best-practices-kb",
  15. "source": "./",
  16. "description": "Auto-invoked skills and slash commands for coding standards, style guides, and best practices across 30+ languages. References resources from Airbnb, Google, Uber, OWASP, and more.",
  17. "version": "1.0.0",
  18. "author": {
  19. "name": "Derek Nguyen"
  20. },
  21. "homepage": "https://github.com/dereknguyen269/programing-best-practices",
  22. "license": "CC0-1.0",
  23. "keywords": [
  24. "best-practices",
  25. "style-guide",
  26. "code-review",
  27. "security",
  28. "clean-code",
  29. "coding-standards"
  30. ],
  31. "category": "code-quality",
  32. "strict": false,
  33. "commands": [
  34. "./commands/"
  35. ]
  36. }
  37. ]
  38. }
README.md Β· README Β· 1,361 lines Β· 1 finding marked

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <a id="top"></a>
  2. <h1 align="center">🌟 Programming Best Practices</h1>
  3. <p align="center">
  4. <strong>Your comprehensive guide to writing better code across 30+ languages and frameworks</strong>
  5. </p>
  6. <p align="center">
  7. <em>Curated resources from industry leaders β€’ Production-ready practices β€’ Always updated</em>
  8. </p>
  9. <div align="center">
  10. <a href="https://github.com/sindresorhus/awesome"><img src="https://awesome.re/badge.svg" alt="Awesome"/></a>
  11. <img src="https://img.shields.io/static/v1?label=%F0%9F%8C%9F&message=If%20Useful&style=flat&color=BC4E99" alt="Star Badge"/>
  12. <img alt="GitHub issues" src="https://img.shields.io/github/issues/dereknguyen269/programing-best-practices" />
  13. <img alt="GitHub stars" src="https://img.shields.io/github/stars/dereknguyen269/programing-best-practices" />
  14. <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/dereknguyen269/programing-best-practices" />
  15. <img alt="Github license" src="https://img.shields.io/github/license/dereknguyen269/programing-best-practices" />
  16. </div>
  17. <div align="center">
  18. <h3 id="quick-links">πŸ”— Quick Links</h3>
  19. <a href="#-backend-development">Backend</a> β€’
  20. <a href="#-frontend-development">Frontend</a> β€’
  21. <a href="#️-database--data">Database</a> β€’
  22. <a href="#-mobile-development">Mobile</a> β€’
  23. <a href="#️-devops--infrastructure">DevOps</a> β€’
  24. <a href="#-ai--data-science">AI/ML</a> β€’
  25. <a href="#️-development-tools--practices">Tools</a> β€’
  26. <a href="#-featured-resources">Featured</a>
  27. </div>
  28. ---
  29. ## πŸ“– Introduction
  30. This repository is a **curated collection of programming best practices** across multiple languages, frameworks, and tools.
  31. It is not an exhaustive list but rather a practical resource containing articles, guidelines, and style guides that have proven helpful in real-world development.
  32. The focus is primarily on **Web Development** (Ruby, Rails, JavaScript, etc.), but it also covers **databases, DevOps, cloud practices, AI tools, and career growth**.
  33. With this collection, I hope to support developers in writing **cleaner, more maintainable code** and growing in their careers.
  34. ### ✨ At a Glance
  35. | | |
  36. |---|---|
  37. | πŸ“š **Resources** | 340+ hand-picked guides, style guides, and official docs |
  38. | πŸ’» **Coverage** | 30+ languages & frameworks across backend, frontend, mobile, data, DevOps, and AI |
  39. | πŸ” **Offline search** | Crawl everything locally and search with BM25 β€” no browser tab-sprawl |
  40. | πŸ€– **AI-native** | Auto-invoked skills for Claude Code and Kiro, plus a Claude Code plugin |
  41. | πŸ”„ **Maintained** | Automated link checking with weekly fix PRs |
  42. **Status:** 🚧 *Work in Progress β€” continuously updated*
  43. ---
  44. ## 🎯 Why This Repository?
  45. ✨ **Curated Quality** β€” Hand-picked resources from industry leaders and experienced developers
  46. πŸš€ **Production-Ready** β€” Practices that work in real-world applications, not just theory
  47. 🌍 **Multi-Language** β€” Covers 30+ programming languages and frameworks
  48. πŸ“š **Comprehensive** β€” From code style to architecture, security to performance
  49. πŸ”„ **Always Updated** β€” Regularly maintained with the latest best practices
  50. πŸ’‘ **Community-Driven** β€” Open to contributions from developers worldwide
  51. ---
  52. > πŸ’‘ **Want offline access, local search, or AI-editor integration?** Jump to [πŸš€ Quick Start Setup](#-quick-start-setup) at the bottom.
  53. ---
  54. ## πŸ“ Repository Structure
  55. ```
  56. programing-best-practices/
  57. β”œβ”€β”€ README.md # Main knowledge base (curated links)
  58. β”œβ”€β”€ index.html # Web landing page
  59. β”œβ”€β”€ contributing.md # Contribution guidelines
  60. β”œβ”€β”€ .claude-plugin/ # πŸ”Œ Claude Code plugin manifest
  61. β”‚ β”œβ”€β”€ marketplace.json
  62. β”‚ └── plugin.json
  63. β”œβ”€β”€ skills/ # 🧠 Claude Code auto-invoked skills
  64. β”‚ └── best-practices/ # πŸ” BM25-powered best practices search
  65. β”‚ β”œβ”€β”€ SKILL.md # Skill instructions
  66. β”‚ β”œβ”€β”€ data/ # CSV databases (resources, languages, categories)
  67. β”‚ └── scripts/ # Search engine (core.py, search.py, generate_csv.py)
  68. β”œβ”€β”€ .kiro/ # Kiro config
  69. β”‚ β”œβ”€β”€ project.md
  70. β”‚ β”œβ”€β”€ steering/ # Kiro steering files (auto-included)
  71. β”‚ β”‚ β”œβ”€β”€ best-practices/ # πŸ” BM25-powered search
  72. β”‚ β”‚ └── ui-ux-pro-max/ # 🎨 UI/UX guidance skill
  73. β”‚ └── resources/ # Project knowledge (decisions, progress)
  74. β”œβ”€β”€ data/
  75. β”‚ └── resources.csv # πŸ“Š Resource index (regenerated by crawler)
  76. β”œβ”€β”€ content/ # πŸ“„ Crawled content (generated β€” not committed)
  77. β”‚ β”œβ”€β”€ index.json # Master index of all resources
  78. β”‚ β”œβ”€β”€ metadata.yaml # Crawl statistics
  79. β”‚ └── ... # Content organized by category
  80. β”œβ”€β”€ scripts/
  81. β”‚ β”œβ”€β”€ crawler/ # πŸ•·οΈ Crawler tools
  82. β”‚ β”‚ β”œβ”€β”€ crawl.py # Main crawler
  83. β”‚ β”‚ β”œβ”€β”€ search.py # Search tool
  84. β”‚ β”‚ β”œβ”€β”€ generate_summaries.py
  85. β”‚ β”‚ └── requirements.txt
  86. β”‚ β”œβ”€β”€ validate_links.py # βœ… Link health checker
  87. β”‚ β”œβ”€β”€ fix_links.py # πŸ”§ Automated link fixer
  88. β”‚ β”œβ”€β”€ auto_maintenance_pr.sh # πŸ€– Weekly maintenance PR automation
  89. β”‚ β”œβ”€β”€ install-skill.py # πŸ”§ Install skill to any project (Claude/Kiro)
  90. β”‚ β”œβ”€β”€ update.sh # πŸ”„ Update resources + reinstall skill
  91. β”‚ β”œβ”€β”€ setup-kb.sh # ⚑ Integrate KB into an existing project
  92. β”‚ └── quick-start.sh # πŸš€ First-time setup for this repo
  93. └── docs/
  94. β”œβ”€β”€ INTEGRATION.md # Integration guide
  95. β”œβ”€β”€ QUICK_START_GUIDE.md # Setup script walkthrough
  96. β”œβ”€β”€ backend.md / frontend.md / database.md / devops.md / mobile.md / ai-ml.md / tools.md
  97. └── images/ # Diagrams and screenshots
  98. ```
  99. > `content/` is generated locally by the crawler and intentionally git-ignored β€” clone the repo and run the setup script to create it.
  100. ---
  101. ## πŸ” Searching the Knowledge Base
  102. After crawling, you can search locally:
  103. ```bash
  104. # Search for JavaScript content
  105. python3 scripts/crawler/search.py "javascript style guide"
  106. # Search within a specific category
  107. python3 scripts/crawler/search.py "best practices" --category python
  108. # Get results as JSON
  109. python3 scripts/crawler/search.py "security" --json
  110. ```
  111. ### BM25-Powered Search (via Skill)
  112. The best-practices skill installed at `.kiro/steering/best-practices/` provides more powerful BM25 search:
  113. ```bash
  114. # Full recommendation (resources + deep content)
  115. python3 .kiro/steering/best-practices/scripts/search.py "ruby rails security" --recommend
  116. # Search by language overview
  117. python3 .kiro/steering/best-practices/scripts/search.py "go" --domain language
  118. # Deep search within crawled markdown files
  119. python3 .kiro/steering/best-practices/scripts/search.py "design patterns" --content --lang python
  120. ```
  121. ### Keeping Resources Up to Date
  122. ```bash
  123. # Update all resources and reinstall the Kiro skill
  124. ./scripts/update.sh
  125. # Update a specific category only
  126. ./scripts/update.sh --category ruby
  127. # Regenerate CSVs and reinstall without re-crawling
  128. ./scripts/update.sh --skip-crawl
  129. ```
  130. ### πŸ› οΈ Troubleshooting
  131. | Problem | Fix |
  132. |---------|-----|
  133. | `python3: command not found` | Install Python 3.8+ and re-run the setup script |
  134. | `source .venv/bin/activate` fails on Windows | Use `.venv\Scripts\activate` instead |
  135. | Crawl is slow or times out | Try `--limit 20` first, or crawl one category: `--category python` |
  136. | Skill not detected by your AI editor | Re-run `./scripts/update.sh --skip-crawl` to reinstall, then restart the editor |
  137. | Found a broken link | Please [open an issue](https://github.com/dereknguyen269/programing-best-practices/issues) β€” link health is checked automatically (see below) |
  138. ### πŸ”„ Maintenance & Link Health
  139. With 340+ external links, rot is inevitable β€” so it's automated:
  140. - **Validation** β€” `scripts/validate_links.py` checks every link in the README
  141. - **Auto-fix** β€” `scripts/fix_links.py` repairs known patterns (e.g., moved or archived URLs)
  142. - **Weekly PRs** β€” `scripts/auto_maintenance_pr.sh` opens a maintenance pull request with link fixes
  143. - **Log** β€” `maintenance_log.txt` records each maintenance run
  144. ```bash
  145. # Check all links yourself
  146. python3 scripts/validate_links.py
  147. # Attempt automatic fixes
  148. python3 scripts/fix_links.py
  149. ```
  150. ---
  151. ## πŸ“š How to Use This Repository
  152. ### For Beginners
  153. 1. **Start with your primary language** β€” Navigate to your language section in the Table of Contents
  154. 2. **Read style guides first** β€” Understanding code style is fundamental
  155. 3. **Practice with examples** β€” Apply the practices in your own projects
  156. 4. **Bookmark for reference** β€” Keep this as a go-to resource when coding
  157. ### For Experienced Developers
  158. 1. **Explore new languages** β€” Learn best practices before starting a new tech stack
  159. 2. **Code review reference** β€” Use during code reviews to maintain quality standards
  160. 3. **Team onboarding** β€” Share relevant sections with new team members
  161. 4. **Stay updated** β€” Check back regularly for new resources and practices
  162. ### For Team Leads
  163. 1. **Establish standards** β€” Use these guides to create team coding standards
  164. 2. **Training resource** β€” Assign relevant sections for team learning
  165. 3. **Quality benchmarks** β€” Set expectations for code quality
  166. 4. **Architecture decisions** β€” Reference system design and scalability sections
  167. ---
  168. ## πŸ€– Use for Existing Projects
  169. Want to integrate this knowledge base into your existing project? We provide multiple options:
  170. ### Option 1: Quick Setup Script
  171. ```bash
  172. # Run the setup script in your project directory
  173. curl -sSL https://raw.githubusercontent.com/dereknguyen269/programing-best-practices/main/scripts/setup-kb.sh | bash
    • Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
    • Line 227 on GitHub
  174. ```
  175. ### Option 2: Git Submodule
  176. ```bash
  177. # Add as a submodule in your project
  178. cd your-project
  179. git submodule add https://github.com/dereknguyen269/programing-best-practices.git .kb/best-practices
  180. ```
  181. ### Option 3: Claude Code Plugin (Recommended for Claude Code users)
  182. Install directly as a Claude Code plugin for automatic best practices guidance:
  183. ```bash
  184. # Step 1: Add the marketplace
  185. /plugin marketplace add dereknguyen269/programing-best-practices
  186. # Step 2: Install the plugin
  187. /plugin install programming-best-practices@programming-best-practices
  188. ```
  189. Once installed, you get:
  190. | Feature | How to Use |
  191. |---------|-----------|
  192. | Auto best practices | Claude automatically references style guides when you write code |
  193. | Security reviews | Claude applies OWASP/security checklists during code review |
  194. | `/programming-best-practices:best-practices [language]` | Look up best practices for any language |
  195. | `/programming-best-practices:review-code` | Review current code against industry standards |
  196. | `/programming-best-practices:setup-standards [stack]` | Generate linter/formatter configs for your stack |
  197. The plugin includes a skill that Claude invokes automatically:
  198. - **best-practices** β€” Activated when writing or reviewing code in any of 30+ languages
  199. ### Option 4: Install Skill with Auto-Crawl (Recommended for Kiro & Claude Code)
  200. Install the BM25-powered best practices skill directly into any project. The installer automatically crawls content, generates searchable CSV databases, and copies the skill:
  201. ```bash
  202. # Full install β€” crawl all 340+ resources + generate CSVs + install skill
  203. python3 scripts/install-skill.py ~/Projects/my-app --mode both
  204. # Install as Claude Code skill only
  205. python3 scripts/install-skill.py ~/Projects/my-app --mode claude
  206. # Install as Kiro steering only
  207. python3 scripts/install-skill.py ~/Projects/my-app --mode kiro
  208. # Quick test β€” crawl only 20 resources
  209. python3 scripts/install-skill.py ~/Projects/my-app --mode both --crawl-limit 20
  210. # Skip crawl β€” use existing content/ data
  211. python3 scripts/install-skill.py ~/Projects/my-app --mode both --skip-crawl
  212. # Crawl specific category only
  213. python3 scripts/install-skill.py ~/Projects/my-app --mode both --crawl-category python
  214. ```
  215. The installer runs a 4-step pipeline:
  216. | Step | What It Does | Time |
  217. |------|-------------|------|
  218. | **1. Dependencies** | Installs crawler requirements (requests, beautifulsoup4, etc.) | ~10s |
  219. | **2. Crawl** | Fetches 340+ resources from README.md links | ~2-10 min |
  220. | **3. Generate CSVs** | Builds BM25-searchable databases (resources, languages, categories) | ~5s |
  221. | **4. Install** | Copies skill with correct paths to target project | ~1s |
  222. Once installed, your AI editor can search best practices:
  223. ```bash
  224. # Search for recommendations (Kiro)
  225. python3 .kiro/steering/best-practices/scripts/search.py "python style guide" --recommend
  226. # Search by domain
  227. python3 .kiro/steering/best-practices/scripts/search.py "react" --domain language
  228. # Deep search in crawled content
  229. python3 .kiro/steering/best-practices/scripts/search.py "clean code" --content --lang javascript
  230. ```
  231. ---
  232. ## ⭐ Featured Resources
  233. Here are some standout resources that every developer should know:
  234. ### πŸ† Must-Read Guides
  235. - **[Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript)** β€” The gold standard for JavaScript coding
  236. - **[Clean Code JavaScript](https://github.com/ryanmcdermott/clean-code-javascript)** β€” Software engineering principles for JavaScript
  237. - **[System Design 101](https://github.com/ByteByteGoHq/system-design-101)** β€” Essential system design concepts
  238. - **[The Twelve-Factor App](https://12factor.net/)** β€” Methodology for building modern cloud-native apps
  239. - **[OWASP Top 10](https://owasp.org/www-project-top-ten/)** β€” Critical security awareness for developers
  240. ### 🎨 Design Patterns
  241. - **[Design Patterns in Python](https://refactoring.guru/design-patterns/python)** β€” Comprehensive pattern guide
  242. - **[Design Patterns in Go](https://refactoring.guru/design-patterns/go)** β€” Go-specific implementations
  243. - **[Design Patterns in Swift](https://github.com/ochococo/Design-Patterns-In-Swift)** β€” Swift pattern examples
  244. ### πŸ”§ Language-Specific Gems
  245. - **[Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md)** β€” Production-grade Go practices
  246. - **[Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide)** β€” Community-driven Ruby standards
  247. - **[Google HTML/CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html)** β€” Google's web standards
  248. ---
  249. ## πŸ“‚ Table of Contents
  250. **πŸ”Ή Backend Development**
  251. **Systems Programming**
  252. * [C](#-c-best-practices)
  253. * [C++](#-c-best-practices-1)
  254. * [Rust](#-rust-best-practices)
  255. **Enterprise & JVM Languages**
  256. * [Java](#-java-best-practices)
  257. * [Kotlin](#-kotlin-best-practices)
  258. * [Scala](#-scala-best-practices)
  259. * [C#](#-c-best-practices-2)
  260. **Web Backend**
  261. * [Node.js](#-nodejs-best-practices)
  262. * [Python](#-python-best-practices)
  263. * [Ruby](#-ruby-best-practices)
  264. * [Rails](#-rails-best-practices)
  265. * [PHP](#-php-best-practices)
  266. * [Laravel](#-laravel-best-practices)
  267. * [NestJS](#-nestjs-best-practices)
  268. * [GraphQL](#-graphql-best-practices)
  269. * [tRPC](#-trpc-best-practices)
  270. **Modern Runtimes**
  271. * [Deno](#-deno-best-practices)
  272. * [Bun](#-bun-best-practices)
  273. **Functional & Specialized**
  274. * [Elixir](#-elixir-best-practices)
  275. * [Go](#-go-golang-best-practices)
  276. * [Swift](#-swift-best-practices)
  277. * [Objective-C](#-objective-c-best-practices)
  278. * [Perl](#-perl-best-practices)
  279. * [Lua](#-lua-best-practices)
  280. **πŸ”Ή Frontend Development**
  281. **Core Technologies**
  282. * [HTML](#-html-best-practices)
  283. * [CSS](#-css-best-practices)
  284. * [SASS](#-sass-best-practices)
  285. * [JavaScript](#-javascript-best-practices)
  286. * [TypeScript](#-typescript-best-practices)
  287. **Frameworks & Libraries**
  288. * [React](#-reactjs-best-practices)
  289. * [Vue](#-vue-best-practices)
  290. * [Angular](#-angular-best-practices)
  291. * [Next.js](#-nextjs-best-practices)
  292. * [Nuxt](#-nuxt-best-practices)
  293. * [Svelte](#-svelte-best-practices)
  294. * [Solid.js](#-solidjs-best-practices)
  295. **Performance**
  296. * [Frontend Performance](#-frontend-performance-best-practices)
  297. **πŸ”Ή Database & Data**
  298. * [SQL](#-sql-best-practices)
  299. * [PostgreSQL](#-postgresql-best-practices)
  300. * [MySQL](#-mysql-best-practices)
  301. **NoSQL & Big Data**
  302. * [NoSQL](#-nosql-best-practices)
  303. **ORMs**
  304. * [Prisma](#-prisma-best-practices)
  305. * [Drizzle ORM](#-drizzle-orm-best-practices)
  306. **πŸ”Ή Mobile Development**
  307. * [Flutter](#-flutter-best-practices)
  308. * [Dart](#-dart-best-practices)
  309. * [React Native](#-react-native-best-practices)
  310. **πŸ”Ή DevOps & Infrastructure**
  311. **Cloud & Deployment**
  312. * [AWS](#-aws-best-practices)
  313. * [Microservices & Cloud-Native](#-microservices--cloud-native-best-practices)
  314. * [Docker](#-docker-best-practices)
  315. * [Kubernetes](#-kubernetes-best-practices)
  316. **Security**
  317. * [API Security](#-api-security-best-practices)
  318. * [DevSecOps](#-devsecops--security-best-practices)
  319. **πŸ”Ή AI & Data Science**
  320. * [AI/ML Engineering](#-aiml-engineering-best-practices)
  321. * [AI Tools for Developers](#-ai-tools-for-developers)
  322. **πŸ”Ή Development Tools & Practices**
  323. **Version Control & Collaboration**
  324. * [Code Review](#-code-review-best-practices)
  325. * [Git](#-git-best-practices)
  326. * [Team Collaboration](#-team--collaboration-best-practices)
  327. **Scripting & Automation**
  328. * [Bash](#-bash-script-best-practices)
  329. **Linting & Formatting**
  330. * [Biome](#biome-best-practices)
  331. **Monorepo**
  332. * [Turborepo](#turborepo-best-practices)
  333. * [Nx](#nx-best-practices)
  334. **Testing**
  335. * [General Testing](#-general-testing-best-practices)
  336. **Performance & Architecture**
  337. * [System Design](#-system-design-best-practices)
  338. * [Performance & Scalability](#-performance--scalability-best-practices)
  339. **πŸ”Ή Specialized Languages**
  340. * [R](#-r-best-practices)
  341. ---
  342. # πŸ”Ή Backend Development
  343. ## Systems Programming
  344. ### πŸ–₯️ C Best Practices
  345. * [C Programming Best Practices – Must know to become an Expert](https://data-flair.training/blogs/c-programming-best-practices/)
  346. * [c-style](https://github.com/mcinglis/c-style) β€” *@mcinglis*
  347. ---
  348. ### πŸ–₯️ C++ Best Practices
  349. * [3 Coding Best Practices for C++](https://www.perforce.com/blog/qac/3-coding-best-practices-cpp)
  350. * [Collaborative Collection of C++ Best Practices](https://github.com/lefticus/cppbestpractices) β€” *@lefticus*
  351. * [The C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines) β€” *@isocpp*
  352. * [C++ Best Practices (CppCon)](https://cppcon.org/cpp-best-practices/)
  353. * [C++ Best Practices by Puppet Labs](https://github.com/puppetlabs/cppbestpractices) β€” *@puppetlabs*
  354. * [Modern C++ Exception Handling](https://docs.microsoft.com/en-us/cpp/cpp/errors-and-exception-handling-modern-cpp) β€” *Microsoft*
  355. * [Top Ten Tips for Correct C++ Coding](https://www.informit.com/articles/article.aspx?p=1712962)
  356. ---
  357. ### πŸ¦€ Rust Best Practices
  358. * [Rust Style Guide](https://github.com/ubsan/style/blob/master/guide.md) β€” *@ubsan*
  359. * [Rust Design Patterns](https://rust-unofficial.github.io/patterns/)
  360. * [Design Patterns in Rust](https://refactoring.guru/design-patterns/rust) β€” *Refactoring.Guru*
  361. ---
  362. ## Enterprise & JVM Languages
  363. ### β˜• Java Best Practices
  364. * [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) β€” 🏒 *Google*
  365. * [Java Best Practices (Oracle)](https://docs.oracle.com/javase/tutorial/java/javaOO/index.html) β€” 🏒 *Oracle Official*
  366. * [Effective Java (Joshua Bloch)](https://www.oreilly.com/library/view/effective-java-3rd/9780134686097/) β€” 🏒 *Industry Standard*
  367. * [Java Coding Best Practices (Baeldung)](https://www.baeldung.com/java-clean-code) β€” *@baeldung*
  368. * [Java Best Practices Guide](https://howtodoinjava.com/java-best-practices/)
  369. * [Java Performance Tuning](https://docs.oracle.com/en/java/javase/21/performance/) β€” 🏒 *Oracle Official*
  370. ---
  371. ### πŸŒ€ Kotlin Best Practices
  372. * [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html) β€” 🏒 *JetBrains Official*
  373. * [Kotlin Style Guide](https://github.com/yole/kotlin-style-guide) β€” *@yole*
  374. * [Kotlin Style Guide (Ray Wenderlich)](https://github.com/raywenderlich/kotlin-style-guide) β€” *@raywenderlich*
  375. ---
  376. ### πŸŒ€ Scala Best Practices
  377. * [Scala Best Practices](https://github.com/alexandru/scala-best-practices) β€” *@alexandru*
  378. * [Databricks Scala Guide](https://github.com/databricks/scala-style-guide) β€” *@databricks*
  379. ---
  380. ### πŸ–₯️ C# Best Practices
  381. * [C# Coding Best Practices – Conventions with Examples](https://www.freecodecamp.org/news/coding-best-practices-in-c-sharp/)
  382. * [22 C# Best Practices](https://code-maze.com/csharp-22-best-practices/)
  383. ---
  384. ## Web Backend
  385. ### 🟒 Node.js Best Practices
  386. * [Node.js Best Practices](https://github.com/goldbergyoni/nodebestpractices) β€” 🏒 *@goldbergyoni (community standard)*
  387. * [Node.js Security Best Practices](https://nodejs.org/en/learn/getting-started/security-best-practices) β€” 🏒 *Node.js Official*
  388. * [Node.js Style Guide (Airbnb fork)](https://github.com/airbnb/javascript) β€” 🏒 *Airbnb*
  389. * [Node.js Performance Best Practices](https://nodejs.org/en/learn/getting-started/introduction-to-nodejs) β€” 🏒 *Node.js Official*
  390. * [Express.js Best Practices (Official)](https://expressjs.com/en/advanced/best-practice-performance.html) β€” 🏒 *Express Official*
  391. * [RisingStack Node.js Style Guide](https://github.com/RisingStack/node-style-guide) β€” *@RisingStack*
  392. ---
  393. ### 🐍 Python Best Practices
  394. * [PEP 8 – Style Guide for Python Code](https://peps.python.org/pep-0008/) β€” 🏒 *Python Official*
  395. * [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) β€” 🏒 *Google*
  396. * [Effective Python (Brett Slatkin)](https://effectivepython.com/)
  397. * [Best of the Best Practices (BOBP) Guide](https://gist.github.com/sloria/7001839) β€” *@sloria*
  398. * [The Hitchhiker's Guide to Python](https://docs.python-guide.org/) β€” *@kennethreitz*
  399. * [Design Patterns in Python](https://refactoring.guru/design-patterns/python) β€” 🏒 *Refactoring.Guru*
  400. * [Python Best Practices (Toptal)](https://www.toptal.com/python/tips-and-practices)
  401. * [Python Anti-Patterns](https://docs.quantifiedcode.com/python-anti-patterns/)
  402. ---
  403. ### πŸ’Ž Ruby Best Practices
  404. * [Ruby Style Guide](https://github.com/airbnb/ruby) β€” *@airbnb*
  405. * [Ruby Tricks & Best Practices](https://github.com/franzejr/best-ruby) β€” *@franzejr*
  406. * [Best Practice Patterns in Ruby](https://github.com/avdi/sbpprb) β€” *@avdi*
  407. * [Ruby Best Practices (Gregory Brown)](https://github.com/practicingruby/rbp-book) β€” *@practicingruby*
  408. * [The Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) β€” *@bbatsov*
  409. * [Shopify Ruby Style Guide](https://github.com/Shopify/ruby-style-guide) β€” *@Shopify*
  410. * [53 Ruby on Rails Interview Questions](https://medium.com/ruby-daily/53-ruby-on-rails-interview-questions-and-answers-eb99eed1aeb7)
  411. * [Ruby Best Practices (Toptal)](https://www.toptal.com/ruby/tips-and-practices)
  412. * [Ruby Best Practices for Beginners](https://deepsource.io/blog/ruby-dev-best-practices-for-beginners/)
  413. * [Ruby Timeouts Guide](https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts) β€” *@ankane*
  414. * [Design Patterns in Ruby](https://refactoring.guru/design-patterns/ruby) β€” *Refactoring.Guru*
  415. * [Best Practices for Writing Ruby](https://reintech.io/blog/best-practices-for-writing-ruby)
  416. * [6 Ruby Best Practices for Beginners](https://www.codementor.io/ruby-on-rails/tutorial/6-ruby-best-practices-beginners-should-know)
  417. ---
  418. ### πŸš‚ Rails Best Practices
  419. * [Rails Style Guide](https://github.com/bbatsov/rails-style-guide) β€” *@bbatsov*
  420. * [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) β€” *@flyerhzm*
  421. * [RSpec Style Guide](https://github.com/reachlocal/rspec-style-guide) β€” *@reachlocal*
  422. * [RSpec Best Practices](https://web.archive.org/web/2024/https://github.com/abinoda/rspec-best-practices) β€” *@abinoda*
  423. * [Rails Database Best Practices](https://web.archive.org/web/2024/https://blog.carbonfive.com/rails-database-best-practices/)
  424. * [Active Record Query Optimization Tips](https://medium.com/@User3141592/active-record-query-performance-tips-a3c3947b968)
  425. * [ActiveRecord SQL Query Optimization](https://phrase.com/blog/posts/activerecord-speed-up-your-sql-queries/)
  426. * [Arel Cheatsheet](https://devhints.io/arel)
  427. * [Production Rails](https://github.com/ankane/production_rails) β€” *@ankane*
  428. * [Securing Sensitive Data in Rails](https://ankane.org/sensitive-data-rails) β€” *@ankane*
  429. * [Toptal Rails Best Practices](https://www.toptal.com/ruby-on-rails/tips-and-practices)
  430. ---
  431. ### 🐘 PHP Best Practices
  432. * [PHP: The Right Way](https://github.com/codeguy/php-the-right-way) β€” *@codeguy*
  433. * [PHP Knowledge](https://github.com/php-earth/php-knowledge) β€” *@php-earth*
  434. * [PHP Coding Standards](https://github.com/maxdmyers/php-style-guide) β€” *@maxdmyers*
  435. ---
  436. ### 🎯 Laravel Best Practices
  437. * [Laravel: The Right Way](https://github.com/laraveltherightway/laraveltherightway.github.io) β€” *@laraveltherightway*
  438. * [Laravel Best Practices](https://github.com/uonick/laravel-best-practices) β€” *@uonick*
  439. ---
  440. ### 🟣 NestJS Best Practices
  441. * [Best NestJS Practices and Advanced Techniques](https://dev.to/drbenzene/best-nestjs-practices-and-advanced-techniques-9m0)
  442. * [NestJS Official Documentation](https://docs.nestjs.com/) β€” 🏒 *NestJS Official*
  443. ---
  444. ### πŸ”· GraphQL Best Practices
  445. * [GraphQL Best Practices (Official)](https://graphql.org/learn/best-practices/) β€” 🏒 *GraphQL Official*
  446. * [Production Ready GraphQL](https://book.productionreadygraphql.com/)
  447. * [GraphQL Security Cheat Sheet (OWASP)](https://cheatsheetseries.owasp.org/cheatsheets/GraphQL_Cheat_Sheet.html) β€” 🏒 *OWASP Official*
  448. * [Awesome GraphQL](https://github.com/chentsulin/awesome-graphql) β€” *@chentsulin*
  449. ### πŸ”Œ tRPC Best Practices
  450. * [tRPC Best Practices (Official)](https://trpc.io/docs/server/routers) β€” 🏒 *tRPC Official*
  451. * [tRPC React Query Integration](https://trpc.io/docs/client/react) β€” 🏒 *tRPC Official*
  452. * [tRPC Security Best Practices](https://trpc.io/docs/server/merging-routers) β€” 🏒 *tRPC Official*
  453. ## Modern Runtimes
  454. ### πŸ¦• Deno Best Practices
  455. * [Deno Best Practices (Official)](https://docs.deno.com/) β€” 🏒 *Deno Official*
  456. * [Deno Style Guide](https://docs.deno.com/) β€” 🏒 *Deno Official*
  457. * [Deno Standard Library](https://jsr.io/@std) β€” 🏒 *Deno Official*
  458. * [Deno Security & Permissions](https://docs.deno.com/runtime/fundamentals/security/) β€” 🏒 *Deno Official*
  459. ### πŸ₯Ÿ Bun Best Practices
  460. * [Bun Best Practices (Official)](https://bun.sh/docs) β€” 🏒 *Bun Official*
  461. * [Bun Runtime Guide](https://bun.sh/docs/runtime) β€” 🏒 *Bun Official*
  462. * [Bun Package Manager](https://bun.sh/docs) β€” 🏒 *Bun Official*
  463. * [Bun Test Runner](https://bun.sh/docs/cli/test) β€” 🏒 *Bun Official*
  464. ---
  465. ## Functional & Specialized
  466. ### πŸ§ͺ Elixir Best Practices
  467. * [The Elixir Style Guide](https://github.com/christopheradams/elixir_style_guide) β€” *@christopheradams*
  468. * [Elixir Style Guide](https://github.com/lexmag/elixir-style-guide) β€” *@lexmag*
  469. * [Credo's Elixir Style Guide](https://github.com/rrrene/elixir-style-guide) β€” *@rrrene*
  470. * [10 Killer Elixir Tips #1](https://medium.com/blackode/10-killer-elixir-tips-2a9be1bec9be)
  471. * [10 Killer Elixir Tips #2](https://medium.com/blackode/10-killer-elixir-tips-2-c5f87f8a70c8)
  472. * [10 Killer Elixir Tips #3](https://medium.com/blackode/10-killer-elixir-tips-3-5c196eaec376)
  473. * [Elixir Cheatsheet](https://devhints.io/elixir)
  474. * [Elixir Metaprogramming Cheatsheet](https://devhints.io/elixir-metaprogramming)
  475. ---
  476. ### 🐹 Go (Golang) Best Practices
  477. * [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md) β€” *@uber-go*
  478. * [Go Best Practices](https://github.com/mehrdadrad/GoBestPractices) β€” *@mehrdadrad*
  479. * [Go Style Guide](https://github.com/AgtLucas/go-style-guide) β€” *@AgtLucas*
  480. * [Golang Tutorial Series](https://golangbot.com/learn-golang-series/)
  481. * [Go Cheat Sheet](https://github.com/a8m/golang-cheat-sheet) β€” *@a8m*
  482. * [Soham Kamani – Golang](https://www.sohamkamani.com/golang/)
  483. * [Design Patterns in Go](https://refactoring.guru/design-patterns/go) β€” *Refactoring.Guru*
  484. ---
  485. ### 🍎 Swift Best Practices
  486. * [Swift Style Guide (Eure)](https://github.com/eure/swift-style-guide) β€” *@eure*
  487. * [Design Patterns in Swift](https://github.com/ochococo/Design-Patterns-In-Swift) β€” *@ochococo*
  488. * [Swift Style Guide (Ray Wenderlich)](https://github.com/raywenderlich/swift-style-guide) β€” *@raywenderlich*
  489. ---
  490. ### 🍏 Objective-C Best Practices
  491. * [NYTimes Objective-C Style Guide](https://github.com/NYTimes/objective-c-style-guide) β€” *@NYTimes*
  492. * [Objective-C Style Guide (Ray Wenderlich)](https://github.com/raywenderlich/objective-c-style-guide) β€” *@raywenderlich*
  493. * [GitHub Objective-C Style Guide](https://github.com/github/objective-c-style-guide) β€” *@github*
  494. * [Code Style & Best Practices for Objective-C](https://github.com/wangshengjia/-Code-Style---Best-Practise-for-Objective-C) β€” *@wangshengjia*
  495. ---
  496. ### πŸͺ Perl Best Practices
  497. * [Effective Perl Programming: Idiomatic Perl](https://www.effectiveperlprogramming.com/)
  498. * [Perl Style Guide](https://perldoc.perl.org/perlstyle) β€” *Perl.org*
  499. ---
  500. ### πŸͺΆ Lua Best Practices
  501. * [Lua Best Practices (Lua.org)](https://www.lua.org/gems/sample.pdf)
  502. * [Lua Style Guide](http://lua-users.org/wiki/LuaStyleGuide)
  503. ---
  504. # 🎨 Frontend Development
  505. ## Core Technologies
  506. ### 🌐 HTML Best Practices
  507. * [HTML Best Practices](https://github.com/hail2u/html-best-practices) β€” *@hail2u*
  508. * [HTML5 (and Some CSS) Best Practice](https://web.archive.org/web/2024/https://www.codeproject.com/Tips/666578/HTML-and-Some-CSS-Best-Practice)
  509. * [Frontend Guidelines](https://github.com/bendc/frontend-guidelines) β€” *@bendc*
  510. * [Google HTML Style Guide](https://google.github.io/styleguide/htmlcssguide.html#HTML) β€” *@google*
  511. ---
  512. ### 🎨 CSS Best Practices
  513. * [Airbnb CSS / Sass Styleguide](https://github.com/airbnb/css) β€” *@airbnb*
  514. * [Dropbox (S)CSS Style Guide](https://github.com/dropbox/css-style-guide) β€” *@dropbox*
  515. * [CSS Coding Standards & Best Practices](https://github.com/stevekwan/best-practices/blob/master/css/best-practices.md) β€” *@stevekwan*
  516. * [Google CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html#CSS) β€” *@google*
  517. ---
  518. ### 🎨 SASS Best Practices
  519. * [Sass Coding Guidelines](https://github.com/bigcommerce/sass-style-guide) β€” *@bigcommerce*
  520. * [Sass-Guidelines](https://github.com/blackfalcon/Sass-Guidlines/blob/master/SASS-Guidelines.md) β€” *@blackfalcon*
  521. * [Sass-lang Style Rules](https://sass-lang.com/documentation/style-rules)
  522. ---
  523. ### πŸ“œ JavaScript Best Practices
  524. * [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) β€” *@airbnb*
  525. * [ES6 Cheatsheet](https://github.com/DrkSephy/es6-cheatsheet) β€” *@DrkSephy*
  526. * [Common JavaScript "Gotchas"](https://github.com/stevekwan/best-practices/blob/master/javascript/gotchas.md) β€” *@stevekwan*
  527. * [Pragmatic JavaScript Standards](https://github.com/stevekwan/best-practices/blob/master/javascript/best-practices.md) β€” *@stevekwan*
  528. * [JavaScript θ§„θŒƒ](https://github.com/adamlu/javascript-style-guide) β€” *@adamlu*
  529. * [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html) β€” *@google*
  530. * [JavaScript The Right Way](https://github.com/braziljs/js-the-right-way) β€” *@braziljs*
  531. * [MDN JavaScript Guidelines](https://developer.mozilla.org/en-US/docs/MDN/Guidelines/Code_guidelines/JavaScript) β€” *@mozilla*
  532. * [W3C JavaScript Best Practices](https://www.w3.org/wiki/JavaScript_best_practices) β€” *@w3c*
  533. * [Clean Code JavaScript](https://github.com/ryanmcdermott/clean-code-javascript) β€” *@ryanmcdermott*
  534. ---
  535. ### 🟦 TypeScript Best Practices
  536. * [TypeScript Best Practices](https://github.com/BestCoderDotInfo/TypeScript-best-practices) β€” *@BestCoderDotInfo*
  537. * [TypeScript Do's and Don'ts](https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html) β€” *TypeScript Official*
  538. * [Clean Code TypeScript](https://github.com/labs42io/clean-code-typescript) β€” *@labs42io*
  539. * [TypeScript Style Guide (Google)](https://google.github.io/styleguide/tsguide.html) β€” *@google*
  540. ---
  541. ## Frameworks & Libraries
  542. ### βš›οΈ ReactJS Best Practices
  543. * [Advanced ReactJS Patterns](https://github.com/kentcdodds/advanced-react-patterns-v2) β€” *@kentcdodds*
  544. * [React Interview Questions & Answers](https://github.com/sudheerj/reactjs-interview-questions) β€” *@sudheerj*
  545. * [React Best Practices (Airbnb)](https://github.com/airbnb/javascript/tree/master/react) β€” *@airbnb*
  546. * [React Patterns](https://reactpatterns.com/) β€” *@chantastic*
  547. * [React TypeScript Cheatsheet](https://github.com/typescript-cheatsheets/react) β€” *@typescript-cheatsheets*
  548. * [Bulletproof React](https://github.com/alan2207/bulletproof-react) β€” *@alan2207*
  549. ---
  550. ### πŸ“± React Native Best Practices
  551. * [React Native Guide](https://github.com/reactnativecn/react-native-guide) β€” *@reactnativecn*
  552. ---
  553. ### πŸ–ΌοΈ Vue Best Practices
  554. * [Vue.js Style Guide (Official)](https://vuejs.org/style-guide/) β€” 🏒 *Vue.js Official*
  555. * [Vue 3 Best Practices (Official)](https://vuejs.org/guide/best-practices/performance.html) β€” 🏒 *Vue.js Official*
  556. * [Vue 3 Composition API Guide](https://vuejs.org/guide/extras/composition-api-faq) β€” 🏒 *Vue.js Official*
  557. * [Vue.js Best Practices](https://learnvue.co/articles/vue-best-practices)
  558. * [10 Good Practices for Large Vue.js Projects](https://www.telerik.com/blogs/10-good-practices-building-maintaining-large-vuejs-projects)
  559. * [Vue Best Practices (Awesome Vue)](https://github.com/vuejs/awesome-vue) β€” *@vuejs*
  560. ---
  561. ### πŸ…°οΈ Angular Best Practices
  562. * [Angular Style Guide (Official)](https://angular.dev/style-guide) β€” 🏒 *Angular Official*
  563. * [Angular Coding Style Guide](https://angular.dev/guide/styleguide) β€” 🏒 *Angular Official*
  564. * [Angular Best Practices for Enterprise Apps](https://www.angulararchitects.io/en/blog/) β€” *angular architects*
  565. * [Angular Performance Checklist](https://github.com/mgechev/angular-performance-checklist) β€” *@mgechev*
  566. ---
  567. ### ⚑ Next.js Best Practices
  568. * [Best Practices for Clean React/Next.js Projects](https://blogs.perficient.com/2023/04/25/best-practices-for-building-and-sustaining-a-clean-react-next-js-project/)
  569. * [10 Tips for Optimal Next.js Performance](https://www.fronttribe.com/stories/next-js-best-practices-10-tips-for-optimal-performance)
  570. * [Best Practices to Increase Next.js Speed](https://stackoverflow.blog/2022/12/20/best-practices-to-increase-the-speed-for-next-js-apps/)
  571. ---
  572. ### ⚑ Nuxt Best Practices
  573. * [Nuxt Style Guide (Official)](https://nuxt.com/docs) β€” 🏒 *Nuxt Official*
  574. * [10 Nuxt Best Practices](https://climbtheladder.com/10-nuxt-best-practices/)
  575. * [Nuxt Best Practices & Tutorials](https://masteringnuxt.com/blog)
  576. ### 🧩 Svelte Best Practices
  577. * [Svelte Best Practices (Official)](https://svelte.dev/docs) β€” 🏒 *Svelte Official*
  578. * [Svelte Style Guide](https://svelte.dev/docs/svelte/typescript) β€” 🏒 *Svelte Official*
  579. * [SvelteKit Best Practices (Official)](https://svelte.dev/docs) β€” 🏒 *SvelteKit Official*
  580. * [Rules of Svelte](https://svelte.dev/docs) β€” 🏒 *Svelte Official*
  581. * [Svelte Performance](https://svelte.dev/docs) β€” 🏒 *Svelte Official*
  582. ### πŸ”΅ Solid.js Best Practices
  583. * [Solid.js Best Practices (Official)](https://docs.solidjs.com/) β€” 🏒 *SolidJS Official*
  584. * [Solid.js Style Guide](https://docs.solidjs.com/) β€” 🏒 *SolidJS Official*
  585. * [SolidStart Best Practices](https://docs.solidjs.com/) β€” 🏒 *SolidJS Official*
  586. ---
  587. ## Performance
  588. ### πŸš€ Frontend Performance Best Practices
  589. * [Frontend Performance Best Practices (Roadmap.sh)](https://roadmap.sh/best-practices/frontend-performance)
  590. * [Web Vitals Best Practices (Google)](https://web.dev/vitals/)
  591. * [High Performance Web Apps (MDN)](https://developer.mozilla.org/en-US/docs/Learn/Performance)
  592. ---
  593. # πŸ—„οΈ Database & Data
  594. ## SQL Databases
  595. ### πŸ“Š SQL Best Practices
  596. * [SQL Style Guide](https://www.sqlstyle.guide)
  597. * [Best Practices for Writing SQL Queries](https://www.metabase.com/learn/sql-questions/sql-best-practices)
  598. * [SQL Performance Explained (Markus Winand)](https://use-the-index-luke.com/)
  599. * [GitLab SQL Style Guide](https://about.gitlab.com/handbook/business-technology/data-team/platform/sql-style-guide/)
  600. ---
  601. ### 🐘 PostgreSQL Best Practices
  602. * [PostgreSQL Performance Best Practices](https://www.adservio.fr/post/postgresql-performance-best-practices)
  603. * [Best Practices for PostgreSQL Database](https://www.e2enetworks.com/blog/best-practices-for-postgresql-database)
  604. * [Run ANALYZE, Run ANALYZE, Run ANALYZE](https://ottertune.com/blog/run-postgresql-analyze-to-fix-a-slowdow-in-db/)
  605. * [Best Practices for Designing PostgreSQL Databases](https://appmaster.io/blog/best-practices-for-designing-postgresql-databases)
  606. ---
  607. ### 🐬 MySQL Best Practices
  608. * [MySQL Performance Best Practices](https://dev.mysql.com/doc/refman/8.0/en/optimization.html)
  609. * [MySQL Security Best Practices](https://dev.mysql.com/doc/refman/8.0/en/security-guidelines.html)
  610. ---
  611. ## NoSQL & Big Data
  612. ### πŸ“¦ NoSQL Best Practices
  613. * [10 NoSQL Data Modeling Best Practices](https://climbtheladder.com/10-nosql-data-modeling-best-practices/)
  614. * [MongoDB Schema Design Best Practices](https://www.mongodb.com/developer/products/mongodb/mongodb-schema-design-best-practices/)
  615. * [11 MongoDB Security Features & Best Practices](https://satoricyber.com/mongodb-security/11-mongodb-security-features-and-best-practices/)
  616. ### πŸ—„οΈ Prisma Best Practices
  617. * [Prisma Best Practices (Official)](https://www.prisma.io/docs/orm/prisma-client/queries/crud) β€” 🏒 *Prisma Official*
  618. * [Prisma Data Modeling Guide](https://www.prisma.io/docs/orm/prisma-schema/data-model) β€” 🏒 *Prisma Official*
  619. * [Prisma Performance Optimization](https://www.prisma.io/docs/orm/prisma-client/queries/query-optimization-performance) β€” 🏒 *Prisma Official*
  620. * [Prisma Security Best Practices](https://www.prisma.io/docs/orm/prisma-client/deployment) β€” 🏒 *Prisma Official*
  621. ### ☁️ Drizzle ORM Best Practices
  622. * [Drizzle ORM Best Practices (Official)](https://orm.drizzle.team/docs/guides) β€” 🏒 *Drizzle Official*
  623. * [Drizzle Schema Design](https://orm.drizzle.team/docs/sql-schema-declaration) β€” 🏒 *Drizzle Official*
  624. * [Drizzle Relations & Joins](https://orm.drizzle.team/docs/rqb) β€” 🏒 *Drizzle Official*
  625. * [Drizzle Production Deployment](https://orm.drizzle.team/docs/migrations) β€” 🏒 *Drizzle Official*
  626. ---
  627. # πŸ“± Mobile Development
  628. ## πŸ“± Flutter Best Practices
  629. * [Performance Best Practices](https://flutter.dev/docs/perf/rendering/best-practices)
  630. * [Flutter: Best Practices and Tips](https://medium.com/flutter-community/flutter-best-practices-and-tips-7c2782c9ebb5) β€” *Kinjal Dhamat*
  631. * [Flutter Development Best Practices](https://heartbeat.fritz.ai/flutter-development-best-practices-3e162765340a) β€” *Derrick Mwiti*
  632. ---
  633. ## 🎯 Dart Best Practices
  634. * [Dart & Flutter Best Practices](https://lazebny.io/flutter-best-practices/)
  635. * [Performance Best Practices](https://docs.flutter.dev/perf/best-practices)
  636. * [Writing Clean Code in Dart: Best Practices & Design Patterns](https://clouddevs.com/dart/clean-code/)
  637. ---
  638. # ☁️ DevOps & Infrastructure
  639. ## Cloud & Deployment
  640. ### ☁️ AWS Best Practices
  641. * [AWS Best Practices (Roadmap.sh)](https://roadmap.sh/best-practices/aws)
  642. * [AWS Well-Architected Framework](https://aws.amazon.com/architecture/well-architected/)
  643. ---
  644. ### πŸ“¦ Microservices & Cloud-Native Best Practices
  645. * [12 Factors for Building Cloud-Native Apps](https://12factor.net/) β€” 🏒 *Standard*
  646. * [Microservices Best Practices (Microsoft)](https://learn.microsoft.com/en-us/azure/architecture/microservices/) β€” 🏒 *Microsoft*
  647. * [Microservices Patterns (Chris Richardson)](https://microservices.io/patterns/index.html) β€” 🏒 *@crichardson*
  648. * [Cloud-Native Patterns (CNCF)](https://github.com/cncf/presentations) β€” 🏒 *CNCF*
  649. * [The Twelve-Factor App](https://12factor.net/) β€” *@heroku*
  650. ---
  651. ### 🐳 Docker Best Practices
  652. * [Docker Best Practices (Official)](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/) β€” *Docker Official*
  653. * [Docker Security Best Practices](https://cheatsheetseries.owasp.org/cheatsheets/Docker_Security_Cheat_Sheet.html) β€” *OWASP*
  654. * [Docker & Kubernetes Best Practices (Google)](https://cloud.google.com/architecture/best-practices-for-building-containers) β€” *@google*
  655. * [Awesome Docker](https://github.com/veggiemonk/awesome-docker) β€” *@veggiemonk*
  656. ---
  657. ### ☸️ Kubernetes Best Practices
  658. * [Kubernetes Best Practices (Google)](https://cloud.google.com/blog/products/containers-kubernetes/your-guide-kubernetes-best-practices) β€” *@google*
  659. * [Kubernetes Production Best Practices](https://learnk8s.io/production-best-practices) β€” *learnk8s*
  660. * [Kubernetes Security Best Practices](https://kubernetes.io/docs/concepts/security/security-checklist/) β€” *Kubernetes Official*
  661. * [Awesome Kubernetes](https://github.com/ramitsurana/awesome-kubernetes) β€” *@ramitsurana*
  662. ---
  663. ## Security
  664. ### πŸ” API Security Best Practices
  665. * [API Security Best Practices (Roadmap.sh)](https://roadmap.sh/best-practices/api-security) β€” 🏒 *Roadmap.sh*
  666. * [API Security Checklist](https://github.com/shieldfy/API-Security-Checklist) β€” *@shieldfy*
  667. * [OWASP API Security Top 10](https://owasp.org/API-Security/editions/2023/en/0x00-header/) β€” 🏒 *OWASP*
  668. * [JWT Best Practices (Auth0)](https://auth0.com/blog/ten-things-you-should-know-about-tokens-and-cookies/) β€” 🏒 *Auth0*
  669. * [REST API Security Best Practices (Microsoft)](https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design) β€” 🏒 *Microsoft*
  670. ---
  671. ### πŸ” DevSecOps & Security Best Practices
  672. * [OWASP Top 10 (2024)](https://owasp.org/www-project-top-ten/)
  673. * [Zero Trust Security Model](https://www.microsoft.com/security/blog/zero-trust/)
  674. * [Best Practices for Secure CI/CD](https://snyk.io/learn/devsecops/)
  675. ---
  676. # πŸ€– AI & Data Science
  677. ## πŸ€– AI/ML Engineering Best Practices
  678. * [MLOps Best Practices (Google Cloud)](https://cloud.google.com/architecture/mlops-continuous-delivery-and-automation-pipelines-in-machine-learning) β€” 🏒 *Google Cloud*
  679. * [Responsible AI Practices (Google)](https://ai.google/responsibilities/responsible-ai-practices/) β€” 🏒 *Google*
  680. * [Anthropic Prompt Engineering Guide](https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/overview) β€” 🏒 *Anthropic Official*
  681. * [OpenAI Prompt Engineering Guide](https://platform.openai.com/docs/guides/prompt-engineering) β€” 🏒 *OpenAI Official*
  682. * [LLM Application Best Practices (Anthropic)](https://docs.anthropic.com/en/docs/build-with-claude) β€” 🏒 *Anthropic Official*
  683. * [IBM Data Science – Best Practices](https://github.com/IBM/data-science-best-practices) β€” *@IBM*
  684. * [ETL Best Practices with Airflow](https://github.com/gtoonstra/etl-with-airflow) β€” *@gtoonstra*
  685. * [dbt Best Practices Guide](https://docs.getdbt.com/guides/best-practices) β€” 🏒 *dbt Official*
  686. * [Structuring AI Agents (Anthropic)](https://docs.anthropic.com/en/docs/build-with-claude) β€” 🏒 *Anthropic Official*
  687. * [Evaluation for LLM Apps (LangSmith)](https://docs.smith.langchain.com/evaluation) β€” *LangChain*
  688. * [LLM Security (OWASP Top 10 for LLM)](https://genai.owasp.org/) β€” 🏒 *OWASP*
  689. ---
  690. ## πŸ€– AI Tools for Developers
  691. * [Effective AI Pair Programming (GitHub Copilot)](https://github.com/features/copilot) β€” 🏒 *GitHub/Microsoft*
  692. * [Cursor AI Best Practices](https://docs.cursor.com/get-started/best-practices) β€” 🏒 *Cursor Official*
  693. * [Claude Code Best Practices](https://docs.anthropic.com/en/docs/claude-code) β€” 🏒 *Anthropic Official*
  694. * [DevOps with AI Agents](https://docs.anthropic.com/en/docs/agents-and-tools) β€” 🏒 *Anthropic Official*
  695. * [Awesome AI Tools](https://github.com/mahseema/awesome-ai-tools) β€” *@mahseema*
  696. * [Best Practices for Coding with AI](https://blog.codacy.com/best-practices-for-coding-with-ai)
  697. * [The Do's and Don'ts of Using AI in Software Development](https://www.kodeco.com/41989083-the-do-s-and-don-ts-of-using-ai-in-software-development)
  698. * [10 Best Practices for Secure AI Development](https://snyk.io/blog/10-best-practices-for-securely-developing-with-ai/)
  699. * [Exploring Generative AI](https://martinfowler.com/articles/exploring-gen-ai.html) β€” *@martinfowler*
  700. * [AI Coding Guidelines (Google)](https://google.github.io/styleguide/) β€” 🏒 *Google*
  701. ---
  702. # πŸ› οΈ Development Tools & Practices
  703. ## Version Control & Collaboration
  704. ### πŸ”Ž Code Review Best Practices
  705. * [Code Review Best Practices (Roadmap.sh)](https://roadmap.sh/best-practices/code-review)
  706. * [Google Code Review Developer Guide](https://google.github.io/eng-practices/review/) β€” *@google*
  707. * [Code Review Best Practices (Palantir)](https://github.com/palantir/gradle-baseline/blob/develop/docs/best-practices/code-reviews/readme.md) β€” *@palantir*
  708. ---
  709. ### 🌿 Git Best Practices
  710. * [Git Best Practices (Seth Robertson)](https://sethrobertson.github.io/GitBestPractices/)
  711. * [Conventional Commits](https://www.conventionalcommits.org/) β€” *Conventional Commits*
  712. * [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) β€” *@nvie*
  713. * [GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow) β€” *GitHub Official*
  714. * [Trunk Based Development](https://trunkbaseddevelopment.com/)
  715. ---
  716. ### πŸ§‘β€πŸ€β€πŸ§‘ Team & Collaboration Best Practices
  717. * [Remote Engineering Best Practices](https://about.gitlab.com/company/culture/all-remote/)
  718. * [Agile Development Best Practices](https://www.atlassian.com/agile)
  719. * [Effective Pair Programming](https://martinfowler.com/articles/on-pair-programming.html)
  720. ---
  721. ## Scripting & Automation
  722. ### 🐚 Bash Script Best Practices
  723. * [Bash Best Practices](https://bertvv.github.io/cheat-sheets/Bash.html)
  724. * [progrium/bashstyle](https://github.com/progrium/bashstyle)
  725. * [Best Practices for Bash Scripts](https://hyperskill.org/learn/step/19230)
  726. * [Shell Style Guide (Google)](https://google.github.io/styleguide/shellguide.html) β€” 🏒 *Google Official*
  727. ## 🧹 Linting & Formatting
  728. ### Biome Best Practices
  729. * [Biome Getting Started](https://biomejs.dev/guides/getting-started/) β€” 🏒 *Biome Official*
  730. * [Biome Configuration Guide](https://biomejs.dev/reference/configuration/) β€” 🏒 *Biome Official*
  731. * [Biome Linter Rules](https://biomejs.dev/linter/) β€” 🏒 *Biome Official*
  732. * [Biome vs ESLint/Prettier Migration](https://biomejs.dev/guides/migrate-eslint-prettier/) β€” 🏒 *Biome Official*
  733. ## πŸ—οΈ Monorepo Best Practices
  734. ### Turborepo Best Practices
  735. * [Turborepo Getting Started](https://turbo.build/repo/docs) β€” 🏒 *Vercel Official*
  736. * [Turborepo Configuration Guide](https://turbo.build/repo/docs/reference/configuration) β€” 🏒 *Vercel Official*
  737. * [Turborepo Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) β€” 🏒 *Vercel Official*
  738. * [Migrating to Turborepo](https://turborepo.com/docs/guides/migrating-from-nx) β€” 🏒 *Vercel Official*
  739. ### Nx Best Practices
  740. * [Nx Getting Started](https://nx.dev/getting-started/intro) β€” 🏒 *Nx Official*
  741. * [Nx Best Practices Guide](https://nx.dev/recipes/enforce-module-boundaries) β€” 🏒 *Nx Official*
  742. * [Nx Monorepo Patterns](https://nx.dev/concepts/decisions/overview) β€” 🏒 *Nx Official*
  743. * [Nx vs Turborepo Trade-offs](https://nx.dev/docs/kb/nx-vs-turborepo) β€” 🏒 *Nx Official*
  744. ---
  745. ## Testing Best Practices
  746. ### πŸ§ͺ General Testing Best Practices
  747. * [JavaScript Testing Best Practices](https://github.com/goldbergyoni/javascript-testing-best-practices) β€” *@goldbergyoni*
  748. * [Unit Testing Best Practices (Microsoft)](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-best-practices) β€” *Microsoft*
  749. * [The Art of Unit Testing](https://www.artofunittesting.com/)
  750. * [Testing Best Practices (Martin Fowler)](https://martinfowler.com/testing/) β€” *@martinfowler*
  751. * [Test-Driven Development (TDD) Guide](https://testdriven.io/test-driven-development/) β€” *testdriven.io*
  752. ---
  753. ## Performance & Architecture
  754. ### πŸ—οΈ System Design Best Practices
  755. * [System Design 101](https://github.com/ByteByteGoHq/system-design-101#system-design-101) β€” *@ByteByteGoHq*
  756. ---
  757. ### ⚑ Performance & Scalability Best Practices
  758. * [Scaling Applications (Netflix Tech Blog)](https://netflixtechblog.com/)
  759. ---
  760. # 🌍 Specialized Languages
  761. ## πŸ“Š R Best Practices
  762. * [Beyond Basic R – Introduction & Best Practices](https://waterdata.usgs.gov/blog/intro-best-practices/)
  763. * [R Code – Best Practices](https://www.r-bloggers.com/r-code-best-practices/)
  764. * [Best Practices for Writing R Code](https://swcarpentry.github.io/r-novice-inflammation/06-best-practices-R.html) β€” *@swcarpentry*
  765. * [R Coding Style Best Practices](https://www.datanovia.com/en/blog/r-coding-style-best-practices/)
  766. * [Good Practices in R Programming (ETH ZΓΌrich)](https://stat.ethz.ch/Teaching/maechler/R/useR_2014/Maechler-2014-pr.pdf)
  767. ---
  768. # πŸ†• What's New
  769. Stay updated with the latest additions to this repository:
  770. ### Recent Updates
  771. - βœ… **Svelte / Solid.js** β€” New frontend framework sections with official best practices
  772. - βœ… **Deno / Bun** β€” Modern runtime best practices (permissions, std lib, testing)
  773. - βœ… **Prisma / Drizzle ORM** β€” ORM design, performance, and deployment guides
  774. - βœ… **tRPC** β€” Type-safe API layer best practices
  775. - βœ… **Biome** β€” Next-gen linter/formatter replacing ESLint/Prettier
  776. - βœ… **Turborepo / Nx** β€” Monorepo architecture and caching patterns
  777. - βœ… **Angular** β€” Updated to modern Angular v19 official guides (replaced AngularJS)
  778. - βœ… **AI/ML Section** β€” Overhauled with Anthropic/OpenAI prompt engineering, AI agents, OWASP LLM security, Copilot/Cursor/Claude Code guides
  779. - βœ… **Quality Badges** β€” 🏒 industry-leader badges added to official resources
  780. ### Coming Soon
  781. - πŸ”œ **Video Tutorials** β€” Curated video resources for visual learners
  782. - πŸ”œ **Code Examples** β€” Practical code snippets demonstrating best practices
  783. - πŸ”œ **Interactive Checklists** β€” Ready-to-use checklists for code reviews
  784. - πŸ”œ **Zig / Gleam** β€” New languages gaining traction
  785. ---
  786. # 🌟 Community & Support
  787. ## πŸ’¬ Get Involved
  788. We believe in the power of community! Here's how you can participate:
  789. ### 🀝 Ways to Contribute
  790. - **πŸ“ Submit Resources** β€” Found a great article or guide? Share it!
  791. - **πŸ› Report Issues** β€” Broken links or outdated content? Let us know!
  792. - **πŸ’‘ Suggest Improvements** β€” Ideas for better organization or new sections?
  793. - **⭐ Star the Repo** β€” Show your support and help others discover this resource
  794. - **πŸ”„ Share** β€” Spread the word on social media, blogs, or with your team
  795. ### πŸ“’ Questions & Ideas
  796. - **Questions?** Open a [GitHub Issue](https://github.com/dereknguyen269/programing-best-practices/issues)
  797. - **Ideas?** Share your thoughts in a [feature request](https://github.com/dereknguyen269/programing-best-practices/issues/new)
  798. - **Showcase** β€” Share how you're using these best practices in your projects
  799. ### πŸ† Contributors
  800. A huge thank you to all our contributors! πŸ™
  801. <a href="https://github.com/dereknguyen269/programing-best-practices/graphs/contributors">
  802. <img src="https://contrib.rocks/image?repo=dereknguyen269/programing-best-practices" />
  803. </a>
  804. ---
  805. # πŸ“ˆ Star History
  806. [![Star History Chart](https://star-history.dera.page/svg?repos=dereknguyen269/programing-best-practices&type=Date)](https://star-history.dera.page/#dereknguyen269/programing-best-practices&Date)
  807. ---
  808. # πŸ’‘ Related Resources
  809. Looking for more? Check out these complementary resources:
  810. - **[Awesome Lists](https://github.com/sindresorhus/awesome)** β€” Curated lists of awesome things
  811. - **[Developer Roadmaps](https://roadmap.sh/)** β€” Step-by-step guides for different tech careers
  812. - **[Free Programming Books](https://github.com/EbookFoundation/free-programming-books)** β€” Extensive collection of free learning resources
  813. - **[Design Resources for Developers](https://github.com/bradtraversy/design-resources-for-developers)** β€” Design and UI resources
  814. - **[The Book of Secret Knowledge](https://github.com/trimstray/the-book-of-secret-knowledge)** β€” Collection of inspiring lists, manuals, cheatsheets, blogs, hacks, one-liners, cli/web tools and more
  815. ---
  816. # 🎯 Repository Stats
  817. <div align="center">
  818. <img src="https://img.shields.io/github/last-commit/dereknguyen269/programing-best-practices?style=for-the-badge" alt="Last Commit"/>
  819. <img src="https://img.shields.io/github/contributors/dereknguyen269/programing-best-practices?style=for-the-badge" alt="Contributors"/>
  820. <img src="https://img.shields.io/github/forks/dereknguyen269/programing-best-practices?style=for-the-badge" alt="Forks"/>
  821. <img src="https://img.shields.io/github/watchers/dereknguyen269/programing-best-practices?style=for-the-badge" alt="Watchers"/>
  822. </div>
  823. ---
  824. # πŸš€ Quick Start Setup
  825. > Just browsing the guides? No setup needed β€” every link above works straight from GitHub. Follow these steps only for **offline access, local search, or AI-editor integration**.
  826. ## βœ… Prerequisites
  827. - **Git** (any recent version)
  828. - **Python 3.8+** with `pip` and `venv` (only needed for crawling, offline search, or installing the AI skill)
  829. - Works on macOS, Linux, and Windows (use `.venv\Scripts\activate` on Windows)
  830. ## 🎯 Automated Setup (Recommended)
  831. The fastest way to get started is using our automated setup script:
  832. ```bash
  833. # Clone the repository
  834. git clone https://github.com/dereknguyen269/programing-best-practices.git
  835. cd programing-best-practices
  836. # Run the interactive setup script
  837. ./scripts/quick-start.sh
  838. ```
  839. The script will guide you through different setup options:
  840. | Mode | Time | What's Included |
  841. |------|------|-----------------|
  842. | **Minimal** | ~1 min | Dependencies only, no crawling |
  843. | **Test** | ~2-3 min | Dependencies + 20 sample resources |
  844. | **Full** | ~10-15 min | Everything + all 340+ resources + AI summaries |
  845. | **Custom** | Varies | Choose specific categories to crawl |
  846. **Quick Options:**
  847. ```bash
  848. # Minimal setup (just dependencies)
  849. ./scripts/quick-start.sh --minimal
  850. # Full setup (everything)
  851. ./scripts/quick-start.sh --full
  852. # Test with 20 resources
  853. ./scripts/quick-start.sh --limit 20
  854. # Crawl only Python resources
  855. ./scripts/quick-start.sh --category python
  856. ```
  857. ## πŸ“‹ Manual Setup (Alternative)
  858. Prefer to set up manually? Follow these steps:
  859. ### Step 1: Clone the Repository
  860. ```bash
  861. git clone https://github.com/dereknguyen269/programing-best-practices.git
  862. cd programing-best-practices
  863. ```
  864. ### Step 2: Install Crawler Dependencies (Optional but Recommended)
  865. The crawler downloads all external resources locally for offline access:
  866. ```bash
  867. # Create virtual environment (recommended)
  868. python3 -m venv .venv
  869. source .venv/bin/activate # On Windows: .venv\Scripts\activate
  870. # Install dependencies
  871. pip install -r scripts/crawler/requirements.txt
  872. ```
  873. ### Step 3: Crawl Resources (Optional)
  874. Download all best practices content locally:
  875. > **Note**: Make sure your virtual environment is activated before running these commands:
  876. > ```bash
  877. > source .venv/bin/activate # On Windows: .venv\Scripts\activate
  878. > ```
  879. >
  880. > Or use the venv Python directly: `.venv/bin/python3` instead of `python3`
  881. ```bash
  882. # Crawl all resources (~340+ links, takes 10-15 minutes)
  883. python3 scripts/crawler/crawl.py
  884. # Or crawl specific categories
  885. python3 scripts/crawler/crawl.py --category python
  886. python3 scripts/crawler/crawl.py --category javascript
  887. # Or crawl a limited number for testing
  888. python3 scripts/crawler/crawl.py --limit 20
  889. # Update existing content
  890. python3 scripts/crawler/crawl.py --update
  891. ```
  892. ### Step 4: Generate AI Summaries (Optional)
  893. Create condensed summaries optimized for AI assistants:
  894. ```bash
  895. python3 scripts/crawler/generate_summaries.py
  896. ```
  897. ### Step 5: Use with Your AI Coding Editor
  898. The repository is now ready! Your AI coding editor will automatically detect:
  899. | AI Editor | Config File | Auto-Detected |
  900. |-----------|-------------|---------------|
  901. | **Claude Code** | `skills/best-practices/` | βœ… |
  902. | **Kiro** | `.kiro/steering/best-practices/` | βœ… |
  903. See [Searching the Knowledge Base](#-searching-the-knowledge-base) and [Troubleshooting](#️-troubleshooting) if you get stuck.
  904. ---
  905. # 🀝 Contributing
  906. Contributions are always welcome! πŸŽ‰
  907. Before contributing, please read the [Contribution Guidelines](contributing.md).
  908. ---
  909. # πŸ’– Support This Project
  910. If you find this repository helpful, here are some ways you can show your support:
  911. ### ⭐ Star This Repository
  912. Click the ⭐ button at the top of this page β€” it helps others discover this resource!
  913. ### πŸ”„ Share With Others
  914. - Share on [Twitter](https://twitter.com/intent/tweet?text=Check%20out%20this%20awesome%20collection%20of%20programming%20best%20practices!&url=https://github.com/dereknguyen269/programing-best-practices)
  915. - Share on [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/dereknguyen269/programing-best-practices)
  916. - Share on [Reddit](https://reddit.com/submit?url=https://github.com/dereknguyen269/programing-best-practices&title=Programming%20Best%20Practices)
  917. - Mention it in your blog posts or tech talks
  918. ### 🀝 Contribute
  919. See our [Contributing Guidelines](contributing.md) to add your favorite resources!
  920. ### β˜• Sponsor
  921. If this project has saved you time or helped your career, consider [sponsoring](https://github.com/sponsors/dereknguyen269) to support continued maintenance and updates.
  922. ---
  923. # ❓ Frequently Asked Questions
  924. ### How often is this repository updated?
  925. This repository is actively maintained and updated regularly. We add new resources as they emerge and remove outdated ones. Check the [What's New](#-whats-new) section for recent updates.
  926. ### Can I suggest a resource?
  927. Absolutely! We welcome contributions. Please read our [Contributing Guidelines](contributing.md) and submit a pull request with your suggestions.
  928. ### Are these practices suitable for beginners?
  929. Yes! We've organized resources for all skill levels. Beginners should start with the [How to Use](#-how-to-use-this-repository) section and focus on style guides first.
  930. ### How do I know which resources to prioritize?
  931. Check out our [Featured Resources](#-featured-resources) section for must-read guides. Also, resources from well-known organizations (Google, Airbnb, etc.) are generally excellent starting points.
  932. ### Can I use this for my team?
  933. Definitely! Many teams use this repository as a reference for establishing coding standards. Feel free to share relevant sections with your team or use them in onboarding materials.
  934. ### Is this repository language-specific?
  935. No, we cover 30+ programming languages and frameworks. Use the [Table of Contents](#-table-of-contents) or [Quick Links](#quick-links) to navigate to your preferred technology.
  936. ### How can I stay updated with new additions?
  937. - ⭐ Star and Watch this repository on GitHub
  938. - Check the [What's New](#-whats-new) section periodically
  939. - Follow the repository for notifications
  940. ### I found a broken link β€” what should I do?
  941. Please [open an issue](https://github.com/dereknguyen269/programing-best-practices/issues) with the broken URL. Links are also validated automatically every week (see [Maintenance & Link Health](#-maintenance--link-health)), so it may already be queued for a fix.
  942. ---
  943. # πŸ“œ License
  944. [![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/)
  945. This project is released into the **public domain** under **[The Unlicense](http://unlicense.org/)** β€” see the [LICENSE](LICENSE) file for details.
  946. ---
  947. <div align="center">
  948. <p><strong>Made with ❀️ by developers, for developers</strong></p>
  949. <p>
  950. <a href="#top">⬆ Back to Top</a>
  951. </p>
  952. </div>
scripts/setup-kb.sh Β· Bundled script Β· 138 lines Β· 1 finding marked
  1. #!/usr/bin/env bash
  2. # =============================================================================
  3. # setup-kb.sh β€” Integrate Programming Best Practices into your project
  4. # =============================================================================
  5. #
  6. # Usage (run from your project root):
  7. # curl -sSL https://raw.githubusercontent.com/dereknguyen269/programing-best-practices/main/scripts/setup-kb.sh | bash
    • Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
    • Line 7 on GitHub
  8. #
  9. # Or locally:
  10. # chmod +x scripts/setup-kb.sh && ./scripts/setup-kb.sh
  11. #
  12. # =============================================================================
  13. set -e
  14. REPO_URL="https://github.com/dereknguyen269/programing-best-practices"
  15. INSTALL_SCRIPT_URL="https://raw.githubusercontent.com/dereknguyen269/programing-best-practices/main/scripts/install-skill.py"
  16. RED='\033[0;31m'
  17. GREEN='\033[0;32m'
  18. YELLOW='\033[1;33m'
  19. BLUE='\033[0;34m'
  20. CYAN='\033[0;36m'
  21. NC='\033[0m'
  22. # ── Helpers ───────────────────────────────────────────────────────────────────
  23. ok() { echo -e "${GREEN} βœ“ $*${NC}"; }
  24. warn() { echo -e "${YELLOW} ⚠ $*${NC}"; }
  25. fail() { echo -e "${RED} βœ— $*${NC}"; exit 1; }
  26. step() { echo -e "\n${CYAN}β–Ά $*${NC}"; }
  27. PYTHON=$(command -v python3 || command -v python || true)
  28. echo -e "${BLUE}"
  29. echo "════════════════════════════════════════════════"
  30. echo " Programming Best Practices β€” Project Setup"
  31. echo "════════════════════════════════════════════════"
  32. echo -e "${NC}"
  33. # ── Detect project root ───────────────────────────────────────────────────────
  34. PROJECT_ROOT="$(pwd)"
  35. if [ ! -d "$PROJECT_ROOT/.git" ]; then
  36. warn "No .git found β€” running from: $PROJECT_ROOT"
  37. fi
  38. # ── Choose integration method ─────────────────────────────────────────────────
  39. echo "How would you like to integrate the knowledge base?"
  40. echo ""
  41. echo " 1) Kiro steering β€” auto-included in every Kiro session (recommended)"
  42. echo " 2) Claude Code skill β€” auto-invoked when writing/reviewing code"
  43. echo " 3) Both β€” install for Kiro + Claude Code"
  44. echo " 4) Git submodule β€” add the full repo as a submodule"
  45. echo ""
  46. read -rp "Choose an option (1-4): " choice
  47. case $choice in
  48. 1) MODE="kiro" ;;
  49. 2) MODE="claude" ;;
  50. 3) MODE="both" ;;
  51. 4) MODE="submodule" ;;
  52. *) fail "Invalid option." ;;
  53. esac
  54. # ── Submodule path ────────────────────────────────────────────────────────────
  55. if [ "$MODE" = "submodule" ]; then
  56. step "Adding Git submodule..."
  57. [ ! -d ".git" ] && fail "Git submodule requires a git repository."
  58. mkdir -p .kb
  59. git submodule add "$REPO_URL" .kb/best-practices
  60. ok "Submodule added at .kb/best-practices"
  61. echo ""
  62. echo " To update later:"
  63. echo " git submodule update --remote .kb/best-practices"
  64. echo ""
  65. echo -e "${GREEN}════════════════════════════════════════════════"
  66. echo " Done!"
  67. echo -e "════════════════════════════════════════════════${NC}"
  68. exit 0
  69. fi
  70. # ── Skill install path ────────────────────────────────────────────────────────
  71. [ -z "$PYTHON" ] && fail "Python not found. Install Python 3 first."
  72. # Crawl options
  73. echo ""
  74. echo "How much content to crawl?"
  75. echo ""
  76. echo " 1) Full β€” all 150+ resources (~10-15 min)"
  77. echo " 2) Quick β€” 20 resources for a fast test (~2 min)"
  78. echo " 3) Skip β€” use existing content/ if already crawled"
  79. echo ""
  80. read -rp "Choose an option (1-3): " crawl_choice
  81. case $crawl_choice in
  82. 1) CRAWL_OPT="" ;;
  83. 2) CRAWL_OPT="--crawl-limit 20" ;;
  84. 3) CRAWL_OPT="--skip-crawl" ;;
  85. *) fail "Invalid option." ;;
  86. esac
  87. # ── Download install-skill.py if running via curl (not inside the repo) ───────
  88. INSTALL_SCRIPT="$(dirname "$0")/install-skill.py"
  89. if [ ! -f "$INSTALL_SCRIPT" ]; then
  90. step "Downloading install-skill.py..."
  91. TMP_DIR=$(mktemp -d)
  92. curl -sSL "$INSTALL_SCRIPT_URL" -o "$TMP_DIR/install-skill.py" \
  93. && ok "Downloaded install-skill.py" \
  94. || fail "Failed to download install-skill.py"
  95. INSTALL_SCRIPT="$TMP_DIR/install-skill.py"
  96. fi
  97. # ── Run installer ─────────────────────────────────────────────────────────────
  98. step "Installing best-practices skill (mode: $MODE)..."
  99. "$PYTHON" "$INSTALL_SCRIPT" "$PROJECT_ROOT" --mode "$MODE" --force $CRAWL_OPT \
  100. && ok "Skill installed" \
  101. || fail "Installation failed"
  102. # ── Post-install summary ──────────────────────────────────────────────────────
  103. echo ""
  104. echo -e "${GREEN}════════════════════════════════════════════════"
  105. echo " Done!"
  106. echo -e "════════════════════════════════════════════════${NC}"
  107. echo ""
  108. if [ "$MODE" = "kiro" ] || [ "$MODE" = "both" ]; then
  109. echo " Kiro: .kiro/steering/best-practices/ (auto-included)"
  110. fi
  111. if [ "$MODE" = "claude" ] || [ "$MODE" = "both" ]; then
  112. echo " Claude Code: skills/best-practices/ (auto-invoked)"
  113. fi
  114. echo ""
  115. echo " To update resources later:"
  116. echo " ./scripts/update.sh"
  117. echo ""
  118. echo " Docs: $REPO_URL"
  119. echo ""

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.