README.md

Best Practices Checklist

Table of Contents

• What is this?
• Why this repo?
• What counts as an acceptable entry?
• Language Specific Resources
  • Rust
  • Go
  • Python
  • Ruby
  • OCaml
  • Erlang
  • Elixir
  • Common Lisp
  • Java
  • Scala
  • D
  • Clojure
  • Nim
  • Pony
  • JavaScript
  • C++
  • Dart
  • General API Design and Tooling

What is this

This document is a collection of language specific resources that one can use to look up the best practices followed by that particular language's community.

Why this repo

I am a programming language enthusiast and I like picking up new languages all the time. Like most curious devs I learn different languages by implementing some side projects using them. This can be achieved by writing quick hacks that mostly turn out to be ugly code but if we want our projects to be publicly available to be used or hacked on by others we must ensure that the code we write is idiomatic and easily understood.

That is the purpose of this repo to serve as a collection of resources that one can quickly look up while building such projects to make sure that their code is idiomatic before they make it public.

What counts as an acceptable entry

It could be anything from articles to books to videos that describes:

• how to write idiomatic code in a particular language
• what build systems / package managers to use and the best practices surrounding these aforementioned tools
• how to good write unit/integration tests
• different styles and idioms of a language
• software design in general etc
• new language section (if you find that the resources for your favourite language are missing feel free to create a new section and add them)

Note: If you are adding a book to the list make sure that it is a free ebook. Amazon links to buy books will not be accepted.

Language Specific Resources

Rust

• Elements of Rust
• Rust Language Reference
• Rust Programming Language (Book)
• Rust Language Cheat Sheet
• Rust Cookbook
• 3 Day Rust Course by Ferrous Systems
• Rust By Example
• Cargo Guide

Go

• Clean Go
• Domain Driven Design in Go
• Learn Go With Tests
• Effective Go
• How to Write Go Code
• The Uber Go Style Guide

Python

• Hitchhiker's Guide to Python
• Python API Checklist
• Design Patterns Implementations
• PEP8
• Design Patterns Toptal Blog Post
• Google Python Style Guide
• wemake-python-styleguide (contains a list of stylistic rules / guidelines for Python code)

Ruby

• RSpec Best Practices
• Let’s Read! — Eloquent Ruby
• Ruby Style Guide
• Best Ruby

OCaml

• OCaml Style Guide

Erlang

• Spawned Shelter

Elixir

• Credo's Elixir Style Guide

Common Lisp

• Standard CL Symbols

Java

• Principles of Lean Java
• Google Java Style Guide
• Java Code Conventions

Scala

• Scala Idioms
• Scala Best Practice Idioms
• Scala School

D

• The D Style
• Pragmatic D Tutorial: Idiomatic D

Clojure

• Clojure Style Guide

Nim

• Nim Style Guide
• Nim Notes

Pony

• Pony Patterns

Javascript

• Eloquent Javascript
• You Don't Know JS
• JS: The Right Way
• Google JavaScript Style Guide

C++

• Google C++ Style Guide

Dart

• Dart Language Tour

General API Design and Tooling

• Designing unix tools