Commit 08c35501 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

tweaks

parent 4c83eb1a

doc/source/codestyle.rst

+1 −1
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ Markup language 
        用户只需要学习为数不多的规则即可开始使用，

        并且在github等各种环境中均有插件支持。

        通常可以使用Markdown格式编写程序说明(`README.md`)

    2.

    2. reStructured Text

doc/source/index.rst

+24 −21
Original line number Diff line number Diff line
@@ -29,10 +29,12 @@ Hello! Welcome to `csst_proto` -- the CSST L1 pipeline prototype. 


引用一句英语谚语："Dress for the job you want, not the one you have."

一个优秀的程序库（repository）应该有许多理想的特征，包含但不限于：



- Use version control （使用版本控制，比如 `git`）

- Use tests （测试/单元测试）

- Have good documentation （有好的文档/注释）

- Use good structure （有好的结构）



尽管要在一个大的project中保持好的结构可能非常难，但这一定是优秀开发者的最求的目标。
@@ -56,9 +58,10 @@ Hello! Welcome to `csst_proto` -- the CSST L1 pipeline prototype. 
   - C7







最后放一个值得 CSST 团队学习的网站



   - LSST团队的内部开发指引：https://developer.lsst.io/



希望这个网站对大家的开发有帮助！