From d8948cdbc41eaa6f8aa09159bef11615163be47d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luis=20Ernesto=20Garc=C3=ADa=20Medina?= Date: Fri, 28 Apr 2023 09:31:10 -0600 Subject: [PATCH] [IMP] CONTRIBUTING.rst: add readme directory to directories section --- website/Contribution/CONTRIBUTING.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/website/Contribution/CONTRIBUTING.rst b/website/Contribution/CONTRIBUTING.rst index 3750711..902ca55 100644 --- a/website/Contribution/CONTRIBUTING.rst +++ b/website/Contribution/CONTRIBUTING.rst @@ -94,6 +94,8 @@ A module is organized in a few directories: * `examples/`: external files `lib/`, ... * `models/`: model definitions +* `readme/`: contains rst files required to make README file of module, for example `CONFIGURE.rst`, `CONTRIBUTORS.rst`... + use ``_ to generate README.rst file. * `reports/`: reporting models (BI/analysis), Webkit/RML print report templates * `static/`: contains the web assets, separated into `css/`, `js/`, `img/`, * `templates/`: if you have several web templates and several backend views you can split them here @@ -185,6 +187,13 @@ The complete tree should look like this: | |-- __init__.py | |-- .py | `-- .py + |-- readme + | |-- CREDITS.rst + | |-- CONFIGURE.rst + | |-- CONTRIBUTORS.rst + | |-- DESCRIPTION.rst + | |-- USAGE.rst + | |-- ROADMAP.rst |-- reports/ | |-- __init__.py | |-- reports.xml