Skip to content
This repository was archived by the owner on Jun 21, 2020. It is now read-only.

Bash: Conventions

Jump to bottom
Scot P. Floess edited this page Nov 8, 2015 · 1 revision

Conventions

Directories

The following represents our directory structure:

  • bash - bash utility scripts and functions.
  • bash/bintray - Bintray related scripts for creating, listing, publishing and deleting artifacts.
  • bash/continuous-delivery - continuous delivery related scripts. Presently only "short cuts" for preparing [Maven] (http://maven.apache.org) and RPM artifacts for release.
  • bash/openshift - OpenShift related scripts that can help with rev'ing artifact versions, pushing out artifacts to Bintray, Github, Bitbucket, etc.
  • test/bash - contains our unit tests (and test suite) for the bash utility scripts.

Naming

Scripts

Scripts are named using lower case words separated by dashes (like git-utils.sh). All utility scripts end in -utils.sh (like common-utils.sh).

Functions

We are somewhat inconsistent in our naming of functions. Initially we started using all lower case dash separated words (like generate-unique). However, we'd like to standardize upon lower camel (like getBackground) per [Issue #48] (https://github.com/FlossWare/scripts/issues/48).

Clone this wiki locally