stackabletech / stackabletech/documentation
Create a developer 'Quickstart' page
未关闭
还没有人认领这个 Issue。
- 主要语言
- CSS
- 星标
- 13
- 派生
- 14
- 平均合并
- 4 天 8 小时
- 30 天内合并 PR
- 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
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
先从仓库现有的贡献者和开发文档开始,然后使用 issue 中提到的命令,包括 cargo clippy --all-targets 和 ./scripts/test.sh。当页面提供简明的依赖项和 Git 签名设置、clone/更改/检查/PR 步骤,并说明如何在 kind 中测试 operator 时,页面即完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- git, rust, shell
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100