Skip to content
Merged
Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Over the past few years, I've written many Bash scripts—some good, some bad, a

Whether you're a beginner looking to avoid common pitfalls or an experienced developer seeking to improve your scripting practices, this guide provides practical advice on error handling, code style, performance considerations, and security practices.

The guide expands significantly upon [bahamas10's Bash Style Guide](https://github.com/bahamas10/bash-style-guide) and incorporates foundational principles from [Wooledge's Bash Practices](http://mywiki.wooledge.org/BashGuide/Practices). Any practices not explicitly covered here generally align with those resources.
While rooted in my own experiences, this guide expands significantly upon [bahamas10's Bash Style Guide](https://github.com/bahamas10/bash-style-guide) and incorporates foundational principles from [Wooledge's Bash Practices](http://mywiki.wooledge.org/BashGuide/Practices). Any practices not explicitly covered here generally align with those resources.

You are encouraged to fork this repository for your own use and contribute to its improvements.
You are encouraged to fork this repository for your own use.

<details>
<summary><strong>Table of Contents</strong></summary>
Expand Down Expand Up @@ -61,8 +61,8 @@ To build and preview the documentation locally, you'll need:

Have a question, idea, or feedback about the guide?

- Use [Discussions](https://github.com/StrangeRanger/bash-style-guide/discussions) to ask questions, propose new or revised guidelines, request clarifications, or share resources and examples.
- Use [Issues](https://github.com/StrangeRanger/bash-style-guide/issues) for actionable problems with the docs or site: broken links, incorrect examples, contradictions, build/deploy problems, or tracked maintenance tasks.
- Use [Discussions](https://github.com/StrangeRanger/bash-style-guide/discussions) to ask questions, propose new or revised guidelines, request clarifications, or share resources and examples.

## Acknowledgments

Expand Down
18 changes: 9 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Bash Style Guide

/// admonition | WARNING
type: warning
Over the past few years, I've written many Bash scripts—some good, some bad, and some downright ugly. This guide distills those experiences into a comprehensive set of best practices for writing safe, predictable, and maintainable Bash scripts.

All guidelines in this document are in a "ready to go" state. Please note that the wording of this guide may be poor, and requires some editing.
Whether you're a beginner looking to avoid common pitfalls or an experienced developer seeking to improve your scripting practices, this guide provides practical advice on error handling, code style, performance considerations, and security practices.

///
While rooted in my own experiences, this guide expands significantly upon [bahamas10's Bash Style Guide](https://github.com/bahamas10/bash-style-guide) and incorporates foundational principles from [Wooledge's Bash Practices](http://mywiki.wooledge.org/BashGuide/Practices). Any practices not explicitly covered here generally align with those resources.

This Bash Style Guide offers detailed recommendations for writing safe, predictable, and maintainable Bash scripts. It is a complete rewrite of the [Bash Style Guide](https://github.com/bahamas10/bash-style-guide) 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 referenced 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.
You are encouraged to fork this [guide on GitHub](https://github.com/StrangeRanger/bash-style-guide) for your own use.

## Preface

This guide strives to be as objective as possible by providing well-founded reasons for each recommended practice. It covers both functional and aesthetic scripting choices. For stylistic preferences that may vary, please refer to the [Aesthetics](guidelines/aesthetics.md) section.

## Report Issues
### Report Issues and Discuss Ideas

If you find any issues with this guide—such as typos, broken links, or incorrect examples—or if you have suggestions for improvement, please use the following:

If you find any issues with this guide, such as typos, broken links, or if you have suggestions for improvement, please create an issue on [GitHub](https://github.com/StrangeRanger/bash-style-guide/issues).
- **[Issues](https://github.com/StrangeRanger/bash-style-guide/issues)**: For actionable problems with the guide or site (typos, broken links, contradictions, build/deploy problems, etc.).
- **[Discussions](https://github.com/StrangeRanger/bash-style-guide/discussions)**: For questions, clarifications, proposing new or revised guidelines, or sharing resources and examples.

## Extra Resources

Expand Down