Professional yak shaver, dogfood enthusiast, plate spinning novice, equestrian hydration engineer
- Pittsburgh, PA
Pinned Loading
-
dbsteward/dbsteward
dbsteward/dbsteward PublicXML based SQL database change management tool
-
-
ansible-sshjail
ansible-sshjail PublicAn Ansible connection plugin for provisioning FreeBSD jails remotely
-
-
-
Run Script, with dev docker image
Run Script, with dev docker image 1One of the biggest barriers to starting in an unfamiliar repo is understanding how to start up the development environment, build the code, and other common tasks. Once a developer is established in a codebase, it's important to minimize development friction with common tasks.
23The `run` script here is a very minimal script that makes it easy to see how to get started, what common tasks are available, and automates those tasks, no matter how trivial. Importantly for long-term maintainability, it allows the "repo maintainers" to change details about, say, starting a dev database, without most other engineers needing to care _how_ that gets done (maybe we use docker-compose, maybe we use raw docker, maybe vagrant). And if they do care, they can just read the script or watch its output.
45Importantly, the script is just plain old bash. Most developers are probably familiar with the syntax, and it's ubiquitous, meaning there's no dependencies to install and no esoteric shell-like syntaxes (like `make`) or libraries (like `rake`) to learn. So long as conventions around declaring commands, variables, and help text are conformed to, the file should be relatively self-documenting and easy to contribute to.
Something went wrong, please refresh the page to try again.
If the problem persists, check the GitHub status page or contact support.
If the problem persists, check the GitHub status page or contact support.