Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[IMP] CONTRIBUTING.rst: add readme directory to directories section #88

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[IMP] CONTRIBUTING.rst: add readme directory to directories section #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions website/Contribution/CONTRIBUTING.rst
View file
Open in desktop
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
ernesto-garcia-tecnativa marked this conversation as resolved.
Show resolved Hide resolved
| |-- DESCRIPTION.rst
| |-- USAGE.rst
| |-- ROADMAP.rst
|-- reports/
| |-- __init__.py
| |-- reports.xml
Expand Down