1egoman / 1egoman/biome

Making `biome help` follow a better format

Ouverte Adaptée aux débutants
#12 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
english hacktoberfest
Langage dominant
Shell
Étoiles
52
Forks
9
Métriques de merge des PR
Aucune PR mergée en 30 j

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!

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Le texte d’aide se trouve dans la grande instruction case à l’intérieur du script bash (probablement biome.sh). Exécute `./biome.sh help` pour voir la sortie actuelle. Cherche le cas `help)` pour modifier le texte d’aide. Documente l’argument optionnel du nom d’environnement pour des commandes comme `biome use`. Rends clairs les deux workflows courants (init/use et la configuration d’un projet cloné) dans la sortie d’aide. Teste en exécutant à nouveau le script pour vérifier les changements.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
bash
Domaine
cli, documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
70/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.