Create a developer 'Quickstart' page

Ouverte
#557 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
git, rust, shell
Domaine
documentation

Piste de recherche

Commencez par la documentation existante du repository sur la contribution et le développement, puis utilisez les commandes mentionnées dans l’issue, notamment cargo clippy --all-targets et ./scripts/test.sh. La page est terminée lorsqu’elle fournit une configuration concise des dépendances et de la signature Git, les étapes de clonage/modification/vérification/PR, et explique comment tester l’opérateur dans kind.

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

Description

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
Langage dominant
CSS
Étoiles
13
Forks
14
Merge moyen
4 j 8 h
PR mergées (30 j)
10

Guide de contribution

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

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de stackabletech/documentation

Toutes les issues de stackabletech/documentation

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

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