docs: add online coverage report (#1529)

* docs: add online coverage report

#1521

* CI: use a much longer time for coverage test

* fix indentations.

* add requirements for cov test

Author: caic99

.github/workflows/coverage.yml

@@ -23,7 +23,7 @@ jobs:
           cmake --install build
       - name: Testing
         run: |
-          cmake --build build --target test ARGS="-V --timeout 7200"
+          cmake --build build --target test ARGS="-V --timeout 21600"
       - name: Upload Coverage to Codecov
         uses: codecov/codecov-action@v3
         if: ${{ ! cancelled() }}

docs/CONTRIBUTING.md

@@ -9,12 +9,12 @@ For more non-technical aspects, please refer to the [ABACUS Contribution Guide](
 - [Got a question?](#got-a-question)
 - [Structure of the package](#structure-of-the-package)
 - [Submitting an Issue](#submitting-an-issue)
-- [Comment Style for documentation](#comment-style-for-documentation)
+- [Comment style for documentation](#comment-style-for-documentation)
 - [Code formatting style](#code-formatting-style)
 - [Generating code coverage report](#generating-code-coverage-report)
 - [Adding a unit test](#adding-a-unit-test)
 - [Submitting a Pull Request](#submitting-a-pull-request)
-- [Commit Message Guidelines](#commit-message-guidelines)
+- [Commit message guidelines](#commit-message-guidelines)
 
 ## Got a question?
 
@@ -39,7 +39,7 @@ The source code of ABACUS is based on several modules. Under the ABACUS root dir
 Before you submit an issue, please search the issue tracker, and maybe your problem has been discussed and fixed. You can [submit new issues](https://github.com/deepmodeling/abacus-develop/issues/new/choose) by filling our issue forms.
 To help us reproduce and confirm a bug, please provide a test case and building environment in your issue.
 
-## Comment Style for documentation
+## Comment style for documentation
 
 ABACUS uses Doxygen to generate docs directly from `.h` and `.cpp` code files.
 
@@ -117,11 +117,11 @@ We use GoogleTest as our test framework. Write your test under the corresponding
 - Add a folder named `test` under the module.
 - Append the content below to `CMakeLists.txt` of the module:
 
-```cmake
-IF (BUILD_TESTING)
-  add_subdirectory(test)
-endif()
-```
+    ```cmake
+    IF (BUILD_TESTING)
+      add_subdirectory(test)
+    endif()
+    ```
 
 - Add a blank `CMakeLists.txt` under `module*/test`.
 
@@ -131,44 +131,41 @@ To add a unit test:
 - Add your testing source code with suffix `*_test.cpp` in `test` directory.
 - Append the content below to `CMakeLists.txt` of the module:
 
-```cmake
-AddTest(
-  TARGET <module_name>_<test_name> # this is the executable file name of the test
-  SOURCES <test_name>.cpp
+    ```cmake
+    AddTest(
+      TARGET <module_name>_<test_name> # this is the executable file name of the test
+      SOURCES <test_name>.cpp
 
-  # OPTIONAL: if this test requires external libraries, add them with "LIBS" statement.
-  LIBS math_libs # `math_libs` includes all math libraries in ABACUS.
-)
-```
+      # OPTIONAL: if this test requires external libraries, add them with "LIBS" statement.
+      LIBS math_libs # `math_libs` includes all math libraries in ABACUS.
+    )
+    ```
 
 - Build with `-D BUILD_TESTING=1` flag. You can find built testing programs under `build/source/<module_name>/test`.
 - Follow the installing procedure of CMake. The tests will move to `build/test`.
 
 ## Generating code coverage report
 
-We use gcov and lcov to generate code coverage report, and only support gcc.
+This feature requires using GCC compiler. We use `gcov` and `lcov` to generate code coverage report.
 
-1. Add -DENABLE_COVERAGE=ON for cmake:
-```
-cmake -B build -DENABLE_COVERAGE=ON
-```
+1. Add `-DENABLE_COVERAGE=ON` for CMake configure command.
 
-2. Build ABACUS.
-```
-cmake --build build -j`nproc`
-cmake --install build
-```
+    ```bash
+    cmake -B build -DBUILD_TESTING=ON -DENABLE_COVERAGE=ON
+    ```
 
-3. Use ``build/abacus`` to run test cases.
+2. Build, install ABACUS, and run test cases.
 
-4. Generate html report.
-```
-cd build/
-make lcov
-```
+3. Generate HTML report.
+
+    ```bash
+    cd build/
+    make lcov
+    ```
+
+Now you can copy `build/lcov` to your local device, and view `build/lcov/html/all_targets/index.html`.
 
-Now you can copy build/lcov to your local device, and view build/lcov/html/all_targets/index.html.
-The current test coverage of ABACUS is reported in [Test Coverage](./community/contribution_guide.md#test-coverage).
+We use [Codecov](https://codecov.io/) to host and visualize our [**code coverage report**](https://app.codecov.io/gh/deepmodeling/abacus-develop). Analysis is scheduled after a new version releases; this [action](https://github.com/deepmodeling/abacus-develop/actions/workflows/coverage.yml) can also be manually triggered.
 
 ## Submitting a Pull Request
 
@@ -219,7 +216,7 @@ To run a subset of unit test, use `ctest -R <test-match-pattern>` to perform tes
     git pull --ff upstream develop
     ```
 
-## Commit Message Guidelines
+## Commit message guidelines
 
 A well-formatted commit message leads a more readable history when we look through some changes, and helps us generate change log.
 We follow up [The Conventional Commits specification](https://www.conventionalcommits.org) for commit message format.

docs/community/contribution_guide.md

@@ -4,17 +4,13 @@
 
 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. 
+- **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.** 
+- **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.
-
-## Test Coverage
-
-The current test coverage of ABACUS is reported with 50.9% line coverage and 69.8% function coverage. Efforts to increase test coverage is appreciated. For more details, developers are referred to [Code Coverage Report](./test-coverage.md).