From 25c640dad2915518b319c02c373204e6fd3e4db3 Mon Sep 17 00:00:00 2001
From: BO ZHANG <bozhang@nao.cas.cn>
Date: Tue, 23 Aug 2022 16:43:24 +0800
Subject: [PATCH] added standards.md

---
 standards.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 standards.md

diff --git a/standards.md b/standards.md
new file mode 100644
index 0000000..8589d83
--- /dev/null
+++ b/standards.md
@@ -0,0 +1,53 @@
+## 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
+
+
-- 
GitLab