dylanaraps/pure-bash-bible

TODO

Open

#2 opened on Jun 14, 2018

View on GitHub
 (8 comments) (3 reactions) (0 assignees)Shell (41,574 stars) (3,637 forks)batch import
good first issuehelp wanted

Description

  • Dynamic variable naming.
  • Internal variables.
  • Turn the non-functions into functions.
    • This is so tests can be written.
    • It also shows a working use case for the task.
  • Add a CONTRIBUTING.md.
  • Look into side effects of using shopt and set.
  • /dev/tcp
  • Convert to pdf
    • Add a cover.
    • Add references.
  • Write some in-depth descriptions for all of the functions.
    • How they work.
    • What tools they replace.
    • Caveats
    • ???
  • Add argument parsing.

Contributor guide

Tech stack
shell
Domain
documentationcli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic bash scriptingfamiliarity with gitshell builtins knowledgemarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the existing repository structure, particularly the main file (likely 'README.md' or a script). Focus on one checklist item, such as adding CONTRIBUTING.md, which is a straightforward documentation task. For technical items like '/dev/tcp' or 'shopt side effects', review the Bash manual and test commands in a sandbox. There are 8 comments on the issue; read them to see if any guidance or prior work was discussed. Since no assignees or PRs exist, any item is available. Start with the smallest, most isolated task to build confidence.
TODO · dylanaraps/pure-bash-bible#2 | Good First Issue