Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tasks to attain production-grade status #5

Open
8 of 21 tasks
GochoMugo opened this issue Jul 30, 2015 · 0 comments
Open
8 of 21 tasks

tasks to attain production-grade status #5

GochoMugo opened this issue Jul 30, 2015 · 0 comments
Assignees
Milestone

Comments

@GochoMugo
Copy link
Owner

For a better, faster, safer user experience:

  • RETAIN A SMOOTH LEARNING CURVE (KISS)
  • write out the principles behind the project (commit)
  • run tests for all these
  • use printf instead of echo (why)
  • use pushd/popd over cd (why)
  • warn user when running as root (commit)
  • ensure variables are set using set -o nounset
  • quote arguments that might have spaces
  • critical sections should use traps
  • actions be atomic
  • perform static analysis (commit)
  • use [ in place of [[ for portability
  • use #!/usr/bin/env bash over #!/bin/bash
  • set magic variables e.g. for current file, basename, and directory
  • use set -o xtrace for debugging
  • use set -o pipefail for errors in pipes
  • use set -o errexit for exiting when error occurs
  • avoid using eval as much as necessary (used here) (do a search)
  • minimal dependencies (issues: check dependencies during msu installation #16)
  • use semantic versioning
  • maintain a changelog

Useful articles/tools:

@GochoMugo GochoMugo self-assigned this Jul 30, 2015
@GochoMugo GochoMugo added this to the v1 milestone Jul 30, 2015
@GochoMugo GochoMugo changed the title use best practices tasks to attain production-grade status Jul 30, 2015
GochoMugo added a commit that referenced this issue Jul 30, 2015
Change:

  Using shellcheck, we can do static analysis on our shell scripts.

Reference: https://github.com/koalaman/shellcheck
Issue: #5
GochoMugo added a commit that referenced this issue Aug 2, 2015
Repository owner locked and limited conversation to collaborators Aug 7, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant