dotnetcore / dotnetcore/SmartCode

SmartCode文档太粗,能不能再细化

未关闭
#50 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
C#
星标
577
派生
167
PR 合并指标
30 天内没有已合并 PR

描述

使用SmartCode的过程中遇到很多问题:
1.不知道怎么建一个配置文件,因为一开始不知道安装目录下有一个SmartCode.yml,可以在这个文件的基础上改。另外也没说明安装目录在哪里
2.NamingConverter只考虑了需要改名的情况,如果不想改表名或者列名,应该怎么处理?
3.IncludeTables和IgnoreTables没有说明要用[ ]包起来,也没有例子
4......

总之最好每个配置项都要给出每种可能的值的例子。说白了就是

贡献指南

这个仓库没有索引到贡献指南

调研方向

从 SmartCode.yml 文件以及现有的安装和配置文档开始。记录已安装的配置文件所在的位置,解释 NamingConverter、IncludeTables 和 IgnoreTables,并为每个可能的配置值添加示例。当配置选项及其示例都得到一致覆盖时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。