stackabletech / stackabletech/documentation

Create a developer 'Quickstart' page

オープン
#557 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
CSS
スター
13
フォーク
14
平均マージ
4日 8時間
マージ済み PR(30日)
10

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、リポジトリに既存のコントリビューター向けドキュメントと開発ドキュメントを確認し、次に cargo clippy --all-targets や ./scripts/test.sh を含む、issue で指定されたコマンドを使用します。依存関係と Git 署名の簡潔なセットアップ、clone/change/check/PR の手順、および kind で operator をテストする方法が記載されていれば、ページは完成です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
git, rust, shell
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。