Commit 25c640da authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

added standards.md

parent 7eb4a123
Pipeline #27 canceled with stages
## CSST L1 Pipeline Standards
### Workplace
Gitlab Group **CSST-L1**:
https://csst-tb.bao.ac.cn/code/csst-l1
### Prototype
https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto
### Structure of files
An example of the tree
```bash
csst_proto
|-csst_proto
| |-data
| | |-test_image.txt
| | |-table_data.txt
| |-__init__.py
| |-flip_image.py
| |-some_other_modules.py
| |-top_level_interface.py
|-tests
|-doc (sphinx directory)
|-setup.py
|-LICENSE
|-README.md
```
1. `setup.py`
this file
2.
### Code style
PEP8.
### Documentation
sphinx-based documentation needs docstrings.
1. docstring styles
- Numpy (recommended)
- Google
### Unit Tests
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