Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Bash Style Guide

[![Project Tracker](https://img.shields.io/badge/repo%20status-Project%20Tracker-lightgrey)](https://wiki.hthompson.dev/en/project-tracker) [![Static Badge](https://img.shields.io/badge/Click%20to%20Access%20Bash%20Style%20Guide-blue)](https://bsg.hthompson.dev)
[![Project Tracker](https://img.shields.io/badge/repo%20status-Project%20Tracker-lightgrey)](https://hthompson.dev/project-tracker#project-255784006) [![Static Badge](https://img.shields.io/badge/Click%20to%20Access%20Bash%20Style%20Guide-blue)](https://bsg.hthompson.dev) [![GitHub License](https://img.shields.io/github/license/StrangeRanger/HThompson)](LICENSE)

> [!NOTE]
> To access the full Bash Style Guide, click the blue badge above or navigate to [bsg.hthompson.dev](https://bsg.hthompson.dev).

Over the past few years, I've written many Bash scripts—some good, some bad, and some downright ugly. This guide distills the lessons I've learned into a set of best practices for writing safe, predictable, and maintainable Bash scripts.

This Bash Style Guide provides detailed recommendations for writing safe and predictable bash scripts. The guidelines in this document are a complete rewrite of the [Bash Style Guide](https://github.com/bahamas10/bash-style-guide) written by [bahamas10](https://github.com/bahamas10), drawing inspiration from the core concepts and ideas in [Wooledge's Bash Practices](http://mywiki.wooledge.org/BashGuide/Practices). While this guide expands upon and reinterprets those foundational principles, any practices not explicitly covered here should be assumed to align with the standards outlined in the aforementioned resources.

You are encouraged to fork this [guide on GitHub](https://github.com/StrangeRanger/bash-style-guide) for your own use and to contribute to its improvement.