Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.

Commit fb37e1f

Browse files
committed
Add submodules section to contributing document
1 parent 147edf7 commit fb37e1f

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

.github/CONTRIBUTING.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,17 @@ together. All topics are described in their own "topic" directories, each with
6767
its own *index.txt*. Topic index file is the :abbr:`TOC (Table of Content)` for
6868
the topic, and it should be added to the master TOC.
6969

70-
.. todo: describe submodules
70+
Submodules
71+
==========
72+
73+
There are two major approaches in the code base organization: monorepo and
74+
multirepo.
75+
76+
This repository uses **hybrid poly-as-mono** approach. It includes several
77+
other repositories as its submodules to glue the content from different repos
78+
together.
79+
80+
Make sure submodules are pulled from the ``devel`` branch.
7181

7282
***************************
7383
Documentation markup syntax

0 commit comments

Comments
 (0)