1egoman / 1egoman/biome

Making `biome help` follow a better format

Abierto Apto para principiantes
#12 0 comentarios 0 reacciones 0 asignados Ver en GitHub
english hacktoberfest
Lenguaje dominante
Shell
Estrellas
52
Forks
9
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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!

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

El texto de ayuda está en la sentencia case grande dentro del script bash (probablemente biome.sh). Ejecuta `./biome.sh help` para ver la salida actual. Busca el caso `help)` para editar el texto de ayuda. Documenta el argumento opcional del nombre del entorno para comandos como `biome use`. Deja claros los dos flujos de trabajo comunes (init/use y configurar un proyecto clonado) en la salida de ayuda. Prueba ejecutando el script de nuevo para verificar los cambios.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
bash
Área
cli, documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
70/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.