Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Create a developer 'Quickstart' page

Aberta
#557 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
45/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
git, rust, shell
Domínio
documentation

Direção de pesquisa

Comece pela documentação existente do repositório para contribuidores e sobre desenvolvimento e, em seguida, use os comandos mencionados na issue, incluindo cargo clippy --all-targets e ./scripts/test.sh. A página estará concluída quando fornecer uma configuração concisa das dependências e da assinatura do Git, as etapas de clonar/alterar/verificar/criar um PR e explicar como testar o operador no kind.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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
Linguagem predominante
CSS
Estrelas
13
Forks
14
Merge médio
1d 13h
PRs com merge (30d)
29

Preparar o ambiente

  • Sem Dockerfile nem arquivo Docker Compose
  • Tem um modelo de pull request
  • Sem guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de stackabletech/documentation

Todas as issues de stackabletech/documentation

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.