stackabletech / stackabletech/documentation
Create a developer 'Quickstart' page
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- CSS
- Estrellas
- 13
- Forks
- 14
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 10
Descripción
As a contributor with maybe some previous knowledge, I don't want to read lenghty instructions on how to get geoing. I want to read a quick page that is mostly shell script commands that I can run to get going.
The goal should be to have a dev environemnt where I can change things in the operator and test it in kind.
steps:
- show how to install the dependencies (
apt install gzip kind kuttl...)- Problem: Lot's of tools, a lot of them installable in a different way, annoying to maintain such a list
- configure git signing
- show how to make changes to an operator
- git clone
- make a change
- run checks (
cargo clippy --all-targets) - run
./scripts/test.sh - Raise PR
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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.
Línea de trabajo
Comienza con la documentación existente del repositorio sobre contribución y desarrollo, y luego usa los comandos mencionados en el issue, incluidos cargo clippy --all-targets y ./scripts/test.sh. La página estará terminada cuando proporcione una configuración concisa de las dependencias y la firma de Git, los pasos para clonar/cambiar/comprobar/crear un PR y explique cómo probar el operador en kind.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- git, rust, shell
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100