CONTRIBUTING.md

帮忙

目录

• 重点讲讲 更新
• 我翻译的结构
• 脚本（2018-11-20）
  • .mds-list存放需要翻译的文件路径, 像:
  • sync-en.sh

Issue or Pull 😊

一般来说, 翻译贡献有 三种

• 勘误
• 校对
• 更新

重点讲讲 更新

原文	与日期	原文更新	更多
commit	2018 **		中文翻译

我会在, 翻译 repo 的开头, 放至 源项目的 commit

你可以通过

1. 如果项目留有的 源 md 文件, 通过直接将新的 commit md 文件覆盖, 然后翻译即可

2. vscode 和 gitlen

简单, 观察

3. git diff

git diff HEAD 9fdf6d1 readme.md >> my.patch

⚠️ 注意: 更新 新的 commit 🔗

我翻译的结构

名	曰
source/	repo 的 git clone, 方便同步
fork/	fork 给自己之后的 git clone, 方便 Pull
.mds-list	存放 source 要翻译的文件路径
sync-en.sh	自动覆盖(根据.mds-list)本库旧版本英文原文md
readme.md	翻译的 commit 与日期之类的信息

绝大多数情况, 我会保留英文原文文件

当然, 你也可以通过 git submodule 来与 英文项目 建立联系

脚本（2018-11-20）

.mds-list存放需要翻译的文件路径, 像:

./source/README.md

一般就存在了，可简单通过 find source/**/*.md输出到此文件

sync-en.sh

详细代码

cat './.mds-list' | while read line || [[ -n ${line} ]]
do
    testseq="zh.md"
    if [[ $line =~ $testseq || "$line" == "" ]]; then
        echo "skip $line"
    else
        lowline=`echo "$line" | awk '{print tolower($0)}'`
        # lowwer string
        zh=${line//source\//}
        dir=$(dirname $zh)
        
        source_readme="./source/readme.md"
        if [[ $lowline == $source_readme ]];then
        # source/[readme|REAMDE].md => en.md
        filename="en.md"
        else 
        # source/other.md => ./other.md
        filename=$(basename $zh)
        fi
        echo "$line >> $dir/$filename"
        mkdir -p $dir && cp $line "$_/$filename"
    fi
done

自动将.mds-list每个路径,复制到 运行命令目录下，如：

• ./source/REAMDE.md => ./en.md(防止覆盖了本库的 readme,一定要有./前缀)
• ./source/other.md => ./other.md

若要更新，需要确保运行source的git pull