Skip to content

Commit

Permalink
[IMP] CONTRIBUTING.rst: add readme directory to directories section
Browse files Browse the repository at this point in the history
  • Loading branch information
ernesto-garcia-tecnativa committed Apr 28, 2023
1 parent 2ae9761 commit d8948cd
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions website/Contribution/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<https://github.com/OCA/maintainer-tools#readme-generator>`_ 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
Expand Down Expand Up @@ -185,6 +187,13 @@ The complete tree should look like this:
| |-- __init__.py
| |-- <main_model>.py
| `-- <inherited_model>.py
|-- readme
| |-- CREDITS.rst
| |-- CONFIGURE.rst
| |-- CONTRIBUTORS.rst
| |-- DESCRIPTION.rst
| |-- USAGE.rst
| |-- ROADMAP.rst
|-- reports/
| |-- __init__.py
| |-- reports.xml
Expand Down

0 comments on commit d8948cd

Please sign in to comment.