README: build from source path and CLI example output are out of date
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 92/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- go
- Área
- build-system, cli, documentation
Línea de trabajo
Actualiza las secciones Source, CLI Example y los ejemplos de toxic-attributes del README. Primero ejecuta make build, inicia ./dist/toxiproxy-server y compara los comandos y la salida documentados con toxiproxy-cli list; se considera terminado cuando la ruta, la indicación del comando, las columnas, el valor de enabled y el uso repetido de -a coincidan con la CLI actual.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
A few parts of the README no longer match what the tools actually do.
- Build from source
The "Source" install section says:
$ make build
$ ./toxiproxy-server
make build writes the binaries to dist/, so ./toxiproxy-server does not exist.
The command should be ./dist/toxiproxy-server.
- CLI example output
In the "CLI Example" section, the output shown for toxiproxy-cli list does not
match the current CLI:
- The hint says
toxiproxy-client inspect <proxyName>, but the CLI prints
toxiproxy-cli inspect <proxyName>. - The columns are shown as
Listen, Upstream, Name, Enabled, Toxicswithtrue
in the Enabled column. The CLI printsName, Listen, Upstream, Enabled, Toxics
and showsenabled.
- Setting multiple toxic attributes
The example only shows a single attribute (-a latency=1000). It is not obvious
how to pass more than one. The CLI accepts the -a flag multiple times
(-a latency=1000 -a jitter=500), which is not mentioned anywhere. This was
also a point of confusion in #139.
Steps to reproduce: build from main with make build, start
./dist/toxiproxy-server, and run the commands from the "CLI Example" section.
- Lenguaje dominante
- Go
- Estrellas
- 12.4k
- Forks
- 509
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Aún no hemos revisado los archivos de configuración de este proyecto. Empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Shopify/toxiproxy
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 38/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
Add docker compose sampleAbierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
Todos los issues de Shopify/toxiproxy
Issues similares
-
[Docs] - Document minimum Terraform/OpenTofu version (>= 1.11) required by write-only argumentsAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 92/100
MagaluCloud/terraform-provider-mgc#323 ·
Los mantenedores suelen responder en 11 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
rossoctl/context-guru#366 ·
Los mantenedores suelen responder en 1 día
-
stage-fail
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
siyuan-note/bazaar#2293 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
piraeusdatastore/piraeus-operator#1070 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día