dotnetcore / dotnetcore/SmartCode

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

Open
#50 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
577
Forks
167
PR merge metrics
No merged PRs in 30d

Description

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

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the SmartCode.yml file and the existing documentation for installation and configuration. Document where the installed configuration file is located, explain NamingConverter, IncludeTables, and IgnoreTables, and add examples for each possible configuration value. Done means the configuration options and their examples are covered consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.