1egoman / 1egoman/biome

Making `biome help` follow a better format

Open
#12 0 comments 0 reactions 0 assignees View on GitHub
english hacktoberfest
Dominant language
Shell
Stars
52
Forks
9
PR merge metrics
No merged PRs in 30d

Description

Unix tools typically have a nice help screen. Biome's is lacking. I'm looking for some help making Biome's help page (`biome help`) a lot more informative and easy to scan.

The two workflows that are most common with Biome:
- Running `biome init` to create a new environment, then `biome use` to start using that environment inside of a new project (similar to `npm init`)
- Running `biome` to set up a freshly-cloned project (similar to an `npm install`)

Willing to work on this? Here's what you'll ideally do:
- Within the source of Biome, run: `./biome.sh help`
- Improve the help text inside of the bash script (look for `help)` in the large case statement)
- I've totally neglected to talk about Biome's ability to specify an optional environment name for any command. For example, `biome use` can take another arg and become `biome use myfancyenvironment` (that command would now apply to `myfancyenvironment` and not the environment specified in the Biomefile). This should be documented somewhere.
- Make the above workflows blatantly obvious.

Thanks!

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.