codrsquad / codrsquad/portable-python
Request: More detailed documentation about the configuration file
未关闭
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 86
- 派生
- 13
- PR 合并指标
- 30 天内没有已合并 PR
描述
This repository has a very high code quality and very decent output.
I notice this portable-python package is quite configurable, but I can't find any documentation about it, and have to read the source code and test cases. It is not very efficient and a little painful.
Is that possible to add more documentation about portable-python.yaml?
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先检查定义 portable-python.yaml 的源代码和测试用例，然后记录可用的配置选项及其用法。当用户无需检查源代码或测试即可理解和配置该软件包时，即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100