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

tweaks

parent 4c83eb1a
Pipeline #112 passed with stages
in 9 seconds
...@@ -30,7 +30,7 @@ Markup language ...@@ -30,7 +30,7 @@ Markup language
用户只需要学习为数不多的规则即可开始使用, 用户只需要学习为数不多的规则即可开始使用,
并且在github等各种环境中均有插件支持。 并且在github等各种环境中均有插件支持。
通常可以使用Markdown格式编写程序说明(`README.md`) 通常可以使用Markdown格式编写程序说明(`README.md`)
2. 2. reStructured Text
......
...@@ -29,36 +29,39 @@ Hello! Welcome to `csst_proto` -- the CSST L1 pipeline prototype. ...@@ -29,36 +29,39 @@ Hello! Welcome to `csst_proto` -- the CSST L1 pipeline prototype.
引用一句英语谚语:"Dress for the job you want, not the one you have." 引用一句英语谚语:"Dress for the job you want, not the one you have."
一个优秀的程序库(repository)应该有许多理想的特征,包含但不限于: 一个优秀的程序库(repository)应该有许多理想的特征,包含但不限于:
- Use version control (使用版本控制,比如 `git`)
- Use tests (测试/单元测试) - Use version control (使用版本控制,比如 `git`)
- Have good documentation (有好的文档/注释) - Use tests (测试/单元测试)
- Use good structure (有好的结构) - Have good documentation (有好的文档/注释)
- Use good structure (有好的结构)
尽管要在一个大的project中保持好的结构可能非常难,但这一定是优秀开发者的最求的目标。 尽管要在一个大的project中保持好的结构可能非常难,但这一定是优秀开发者的最求的目标。
这里的主要内容包括 这里的主要内容包括
- 版本控制 (version control) - 版本控制 (version control)
- how to use `git` - how to use `git`
- 代码风格 (Code style) - 代码风格 (Code style)
- PEP8 for Python - PEP8 for Python
- PEP7 for C - PEP7 for C
- Numpydoc - Numpydoc
- 单元测试 (unit test) - 单元测试 (unit test)
- `unittest` - `unittest`
- `doctest` - `doctest`
- gitlab CI/CD pipeline - gitlab CI/CD pipeline
- 文件结构 (file structures) - 文件结构 (file structures)
- CSST一级流水线功能模块命名 - CSST一级流水线功能模块命名
- -
- 开发时间线 (timeline for CSST developers) - 开发时间线 (timeline for CSST developers)
- C6 - C6
- C7 - C7
最后放一个值得 CSST 团队学习的网站 最后放一个值得 CSST 团队学习的网站
- LSST团队的内部开发指引:https://developer.lsst.io/ - LSST团队的内部开发指引:https://developer.lsst.io/
希望这个网站对大家的开发有帮助! 希望这个网站对大家的开发有帮助!
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment