.dotfiles

Development Standards and Guidelines

Code style, formatting, and development practices

Overview

This section contains guides for maintaining consistent code quality and style across the dotfiles repository and your development projects.

Available Guides

Fixy — Universal Code Formatter

The fixy script (documented in tools/README.md) combines:

• File operations (trailing whitespace, tabs)
• Language-specific formatters
• Smart quote normalization

Indentation Guide

Industry standard compliance:

• Python: 4 spaces
• Other languages: 2 spaces
• Exceptions: Go (tabs), Makefiles (tabs)

Style Guide

Comprehensive coding standards:

• Language-specific conventions
• Naming patterns
• Documentation requirements

Quick Reference

Python

# 4 spaces, 100 char lines
def example_function(parameter_one: str,
                    parameter_two: int) -> bool:
    """Docstring with industry-standard format."""
    return True

JavaScript/TypeScript

// 2 spaces, modern syntax
const exampleFunction = async (param) => {
  const result = await fetchData(param);
  return result;
};

Shell

# 2 spaces, industry standard
main() {
  local arg="${1}"
  if [[ -z "${arg}" ]]; then
    echo "Error: Missing argument" >&2
    return 1
  fi
}

Enforcement

These standards are enforced through:

1. Editor Configuration - src/editorconfig and language servers
2. Formatters - Automated via fixy script
3. Linters - Pre-commit hooks and CI checks
4. Code Review - Manual verification

Resources

• Industry-standard style guides
• Local copy: styleguide/ (git submodule)

---

← Back to Guides

This site is open source. Improve this page.