Merge pull request #1411 from hongriTianqi/contribute

docs: skeleton of developer docs
deepmodeling · Oct 24, 2022 · 687235a · 687235a
2 parents 2ac9cb9 + 72d1b19
commit 687235a
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 18 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -1,7 +1,8 @@
 # Contributing to ABACUS
 
-First of all, thank you for taking time making contributions to ABACUS!
-This file provides a guideline for it.
+First of all, thank you for taking time to make contributions to ABACUS!
+This file provides the more technical guidelines on how to realize it.
+For more non-technical aspects, please refer to the [ABACUS Contribution Guide](./community/contribution_guide.md)
 
 ## Table of Contents
 

diff --git a/docs/community/contribution_guide.md b/docs/community/contribution_guide.md
@@ -0,0 +1,16 @@
+# ABACUS Contribution Guide
+
+## Contribution Process
+
+We welcome contributions from the open source community. The technical guide is provided in [Contributing to ABACUS](../CONTRIBUTING.md). Here is the basic contribution process:
+
+- **Find out issues to work on.** 
+We assume you already have a good idea on what to do, otherwise the [issue tracker](https://github.com/deepmodeling/abacus-develop/issues) and [discussion](https://github.com/deepmodeling/abacus-develop/discussions) panel provide good starting points to find out what to work on and to get familiar with the project. 
+
+- **Approach the issue.** 
+It is suggested to [submit new issues](https://github.com/deepmodeling/abacus-develop/issues/new/choose) before coding out changes to involve more discussions and suggestions from development team. Refer to the technical guide in [Contributing to ABACUS](../CONTRIBUTING.md) when needed.
+
+- **Open a pull request.** The ABACUS developers review the pull request (PR) list regularly. If the work is not ready, convert it to draft until finished, then you can mark it as "Ready for review". It is suggested to open a new PR through forking a repo and creating a new branch on you Github account. A new PR should include as much information as possible in `description` when submmited. Unittests or CI tests are required for new PRs.
+
+- **Iterate the pull request.**
+All pull requests need to be tested through CI before reviewing. A pull request might need to be iterated several times before accepted, so splitting a long PR into parts reduces reviewing difficulty for us.
diff --git a/docs/community/faq.md b/docs/community/faq.md
@@ -0,0 +1,3 @@
+# Frequently Asked Questions
+
+We collect frequently asked questions from issues/user feedbacks here.
diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -56,11 +56,13 @@ the developments and applications of novel machine-learning-assisted DFT methods
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contributing to ABACUS
+   :caption: Community
 
+   community/contribution_guide
    CONTRIBUTING
 
 .. toctree::
-   :maxdepth: 2
-   :caption: FAQ
+   :glob:
+   :titlesonly:
 
+   community/faq
diff --git a/docs/quick_start/hands_on.md b/docs/quick_start/hands_on.md
@@ -77,23 +77,23 @@ mpirun -np 2 abacus
 The main output information is stored in the file `OUT.MgO/running_scf.log`, which starts with
 
 ```
-                             WELCOME TO ABACUS                                       
-                                                                                     
-               'Atomic-orbital Based Ab-initio Computation at UStc'                  
-                                                                                     
-                     Website: http://abacus.ustc.edu.cn/                             
-                                                                                     
+                             WELCOME TO ABACUS v3.0
+
+               'Atomic-orbital Based Ab-initio Computation at UStc'
+
+                     Website: http://abacus.ustc.edu.cn/
+
     Version: Parallel, in development
     Processor Number is 2
-    Start Time is Sat Sep 24 13:06:35 2022
-                                                                                     
+    Start Time is Mon Oct 24 01:47:54 2022
+
  ------------------------------------------------------------------------------------
 
  READING GENERAL INFORMATION
                            global_out_dir = OUT.MgO/
                            global_in_card = INPUT
-                               pseudo_dir = 
-                              orbital_dir = 
+                               pseudo_dir =
+                              orbital_dir =
                                     DRANK = 1
                                     DSIZE = 2
                                    DCOLOR = 1
@@ -117,6 +117,7 @@ The main output information is stored in the file `OUT.MgO/running_scf.log`, whi
  | in real and reciprocal space is also shown.                        |
  |                                                                    |
  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+
 ......
 
 ```