From 5f895b02698888b7859e2b79f972b592b27b7754 Mon Sep 17 00:00:00 2001 From: jscampucci Date: Wed, 17 Sep 2025 13:42:07 +0200 Subject: [PATCH] [WIP] test pre-commit readme --- .pre-commit-config.yaml | 3 +- crm_usability_misc/README.rst | 194 +++++- crm_usability_misc/__manifest__.py | 2 +- crm_usability_misc/readme/CONFIGURE.md | 10 + crm_usability_misc/readme/CONTEXT.md | 16 + crm_usability_misc/readme/CONTRIBUTORS.md | 2 + crm_usability_misc/readme/CREDITS.md | 7 + crm_usability_misc/readme/DESCRIPTION.md | 7 + crm_usability_misc/readme/HISTORY.md | 22 + crm_usability_misc/readme/INSTALL.md | 7 + crm_usability_misc/readme/ROADMAP.md | 5 + crm_usability_misc/readme/USAGE.md | 21 + .../static/description/index.html | 554 ++++++++++++++++++ 13 files changed, 825 insertions(+), 25 deletions(-) create mode 100644 crm_usability_misc/readme/CONFIGURE.md create mode 100644 crm_usability_misc/readme/CONTEXT.md create mode 100644 crm_usability_misc/readme/CONTRIBUTORS.md create mode 100644 crm_usability_misc/readme/CREDITS.md create mode 100644 crm_usability_misc/readme/DESCRIPTION.md create mode 100644 crm_usability_misc/readme/HISTORY.md create mode 100644 crm_usability_misc/readme/INSTALL.md create mode 100644 crm_usability_misc/readme/ROADMAP.md create mode 100644 crm_usability_misc/readme/USAGE.md create mode 100644 crm_usability_misc/static/description/index.html diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b868283..9abafc6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -49,7 +49,8 @@ repos: $(git rev-parse --show-toplevel))"' - id: oca-gen-addon-readme entry: - bash -c 'oca-gen-addon-readme --addons-dir=. --branch=16.0 + bash -c 'oca-gen-addon-readme --addons-dir=. --branch=$(git symbolic-ref + refs/remotes/origin/HEAD | sed "s@^refs/remotes/origin/@@") --repo-name=$(basename $(git rev-parse --show-toplevel)) --org-name="Elabore" --if-source-changed --keep-source-digest' diff --git a/crm_usability_misc/README.rst b/crm_usability_misc/README.rst index 398cc72..0bb2dce 100644 --- a/crm_usability_misc/README.rst +++ b/crm_usability_misc/README.rst @@ -1,51 +1,199 @@ -=============== -crm_usability_misc -=============== +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association -Various modification of CRM app +================== +crm usability misc +================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:be78325679fda626093147ef1d7023041e2544e8c1cca85c4c7199e4848f8c6f + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-Elabore%2Fcrm--tools-lightgray.png?logo=github + :target: https://github.com/Elabore/crm-tools/tree/16.0/crm_usability_misc + :alt: Elabore/crm-tools + +|badge1| |badge2| |badge3| + +[ This file must be max 2-3 paragraphs, and is required. + +The goal of this document is to explain quickly the features of this +module: “what” this module does and “what” it is for. ] + +Example: + +This module extends the functionality of ... to support ... and to allow +users to ... + +**Table of contents** + +.. contents:: + :local: + +Use Cases / Context +=================== + +[ This file is optional but strongly suggested to allow end-users to +evaluate the module's usefulness in their context. ] + +BUSINESS NEED: It should explain the “why” of the module: + +- what is the business requirement that generated the need to develop + this module +- in which context or use cases this module can be useful (practical + examples are welcome!). + +APPROACH: It could also explain the approach to address the mentioned +need. + +USEFUL INFORMATION: It can also inform on related modules: + +- modules it depends on and their features +- other modules that can work well together with this one +- suggested setups where the module is useful (eg: multicompany, + multi-website) Installation ============ -Use Odoo normal module installation procedure to install -``crm_usability_misc``. +[ This file must only be present if there are very specific installation +instructions, such as installing non-python dependencies. The audience +is systems administrators. ] -Description -=========== +To install this module, you need to: -- Hide the Campaign and Medium fields -- Hove “Source” and “Referred by” under Tags -- Move “Sales team” under Phone +1. Do this ... + +Configuration +============= + +[ This file is not always required; it should explain **how to configure +the module before using it**; it is aimed at users with administration +privileges. + +Please be detailed on the path to configuration (eg: do you need to +activate developer mode?), describe step by step configurations and the +use of screenshots is strongly recommended.] + +To configure this module, you need to: + +- Go to *App* > Menu > Menu item +- Activate boolean… > save +- … + +Usage +===== + +[ This file is required and contains the instructions on **“how”** to +use the module for end-users. + +If the module does not have a visible impact on the user interface, just +add the following sentence: + + This module does not impact the user interface. + +If that’s not the case, please make sure that every usage step is +covered and remember that images speak more than words!] + +To use this module, you need to: + +- Go to *App* > Menu > Menu item + + *insert screenshot!* + +- In “Contact” form, add a value to field *xyz* > save + + *insert screenshot!* + +- The value of *xyz* is now displayed in the list view. + + *insert screenshot!* Known issues / Roadmap ====================== -None yet. +[ Enumerate known caveats and future potential improvements. It is +mostly intended for end-users, and can also help potential new +contributors discovering new features to implement. ] + +- ... + +Changelog +========= + +[ The change log. The goal of this file is to help readers understand +changes between version. The primary audience is end users and +integrators. Purely technical changes such as code refactoring must not +be mentioned here. + +This file may contain ONE level of section titles, underlined with the ~ +(tilde) character. Other section markers are forbidden and will likely +break the structure of the README.rst or other documents where this +fragment is included. ] + +11.0.x.y.z (YYYY-MM-DD) +----------------------- + +- [BREAKING] Breaking changes come first. + (`#70 `__) +- [ADD] New feature. (`#74 `__) +- [FIX] Correct this. (`#71 `__) + +11.0.x.y.z (YYYY-MM-DD) +----------------------- + +- ... Bug Tracker =========== -Bugs are tracked on `our issues website `_. In case of -trouble, please check there if your issue has already been -reported. If you spotted it first, help us smashing it by providing a -detailed and welcomed feedback. +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= +Authors +------- + +* Elabore + Contributors ------------ -* `Elabore ` +- Firstname Lastname email.address@example.org (optional company website + url) +- Second Person second.person@example.org (optional company website url) -Funders -------- +Other credits +------------- + +[ This file is optional and contains additional credits, other than +authors, contributors, and maintainers. ] The development of this module has been financially supported by: -* Elabore (https://elabore.coop) +- Company 1 name +- Company 2 name -Maintainer ----------- +Maintainers +----------- -This module is maintained by Elabore. \ No newline at end of file +This module is part of the `Elabore/crm-tools `_ project on GitHub. + +You are welcome to contribute. diff --git a/crm_usability_misc/__manifest__.py b/crm_usability_misc/__manifest__.py index 8f74f35..641637e 100644 --- a/crm_usability_misc/__manifest__.py +++ b/crm_usability_misc/__manifest__.py @@ -5,7 +5,7 @@ "name": "crm usability misc", "version": "16.0.1.0.0", "author": "Elabore", - "website": "https://git.elabore.coop", + "website": "https://git.elabore.coop/elabore/crm-tools", "maintainer": "Elabore", "license": "AGPL-3", "category": "CRM", diff --git a/crm_usability_misc/readme/CONFIGURE.md b/crm_usability_misc/readme/CONFIGURE.md new file mode 100644 index 0000000..2fdb0e6 --- /dev/null +++ b/crm_usability_misc/readme/CONFIGURE.md @@ -0,0 +1,10 @@ +[ This file is not always required; it should explain **how to configure the module before using it**; it is aimed at users with administration privileges. + +Please be detailed on the path to configuration (eg: do you need to activate developer mode?), describe step by step configurations and the use of screenshots is strongly recommended.] + + +To configure this module, you need to: + +- Go to *App* > Menu > Menu item +- Activate boolean… > save +- … diff --git a/crm_usability_misc/readme/CONTEXT.md b/crm_usability_misc/readme/CONTEXT.md new file mode 100644 index 0000000..096235a --- /dev/null +++ b/crm_usability_misc/readme/CONTEXT.md @@ -0,0 +1,16 @@ +[ This file is optional but strongly suggested to allow end-users to evaluate the +module's usefulness in their context. ] + +BUSINESS NEED: +It should explain the “why” of the module: +- what is the business requirement that generated the need to develop this module +- in which context or use cases this module can be useful (practical examples are welcome!). + +APPROACH: +It could also explain the approach to address the mentioned need. + +USEFUL INFORMATION: +It can also inform on related modules: +- modules it depends on and their features +- other modules that can work well together with this one +- suggested setups where the module is useful (eg: multicompany, multi-website) diff --git a/crm_usability_misc/readme/CONTRIBUTORS.md b/crm_usability_misc/readme/CONTRIBUTORS.md new file mode 100644 index 0000000..7be72fb --- /dev/null +++ b/crm_usability_misc/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- Firstname Lastname (optional company website url) +- Second Person (optional company website url) diff --git a/crm_usability_misc/readme/CREDITS.md b/crm_usability_misc/readme/CREDITS.md new file mode 100644 index 0000000..9c2b025 --- /dev/null +++ b/crm_usability_misc/readme/CREDITS.md @@ -0,0 +1,7 @@ +[ This file is optional and contains additional credits, other than + authors, contributors, and maintainers. ] + +The development of this module has been financially supported by: + +- Company 1 name +- Company 2 name diff --git a/crm_usability_misc/readme/DESCRIPTION.md b/crm_usability_misc/readme/DESCRIPTION.md new file mode 100644 index 0000000..2371a14 --- /dev/null +++ b/crm_usability_misc/readme/DESCRIPTION.md @@ -0,0 +1,7 @@ +[ This file must be max 2-3 paragraphs, and is required. + +The goal of this document is to explain quickly the features of this module: “what” this module does and “what” it is for. ] + +Example: + +This module extends the functionality of ... to support ... and to allow users to ... diff --git a/crm_usability_misc/readme/HISTORY.md b/crm_usability_misc/readme/HISTORY.md new file mode 100644 index 0000000..a6daf58 --- /dev/null +++ b/crm_usability_misc/readme/HISTORY.md @@ -0,0 +1,22 @@ +[ The change log. The goal of this file is to help readers + understand changes between version. The primary audience is + end users and integrators. Purely technical changes such as + code refactoring must not be mentioned here. + + This file may contain ONE level of section titles, underlined + with the ~ (tilde) character. Other section markers are + forbidden and will likely break the structure of the README.rst + or other documents where this fragment is included. ] + +## 11.0.x.y.z (YYYY-MM-DD) + +- [BREAKING] Breaking changes come first. + ([#70](https://github.com/OCA/repo/issues/70)) +- [ADD] New feature. + ([#74](https://github.com/OCA/repo/issues/74)) +- [FIX] Correct this. + ([#71](https://github.com/OCA/repo/issues/71)) + +## 11.0.x.y.z (YYYY-MM-DD) + +- ... diff --git a/crm_usability_misc/readme/INSTALL.md b/crm_usability_misc/readme/INSTALL.md new file mode 100644 index 0000000..77b98e7 --- /dev/null +++ b/crm_usability_misc/readme/INSTALL.md @@ -0,0 +1,7 @@ +[ This file must only be present if there are very specific + installation instructions, such as installing non-python + dependencies. The audience is systems administrators. ] + +To install this module, you need to: + +1. Do this ... diff --git a/crm_usability_misc/readme/ROADMAP.md b/crm_usability_misc/readme/ROADMAP.md new file mode 100644 index 0000000..446840c --- /dev/null +++ b/crm_usability_misc/readme/ROADMAP.md @@ -0,0 +1,5 @@ +[ Enumerate known caveats and future potential improvements. + It is mostly intended for end-users, and can also help + potential new contributors discovering new features to implement. ] + +- ... diff --git a/crm_usability_misc/readme/USAGE.md b/crm_usability_misc/readme/USAGE.md new file mode 100644 index 0000000..2cf1275 --- /dev/null +++ b/crm_usability_misc/readme/USAGE.md @@ -0,0 +1,21 @@ +[ This file is required and contains the instructions on **“how”** to use the module for end-users. + +If the module does not have a visible impact on the user interface, just add the following sentence: + +> This module does not impact the user interface. + +If that’s not the case, please make sure that every usage step is covered and remember that images speak more than words!] + +To use this module, you need to: + +- Go to *App* > Menu > Menu item + + *insert screenshot!* + +- In “Contact” form, add a value to field *xyz* > save + + *insert screenshot!* + +- The value of *xyz* is now displayed in the list view. + + *insert screenshot!* diff --git a/crm_usability_misc/static/description/index.html b/crm_usability_misc/static/description/index.html new file mode 100644 index 0000000..3824d90 --- /dev/null +++ b/crm_usability_misc/static/description/index.html @@ -0,0 +1,554 @@ + + + + + +README.rst + + + +
+ + + +Odoo Community Association + +
+

crm usability misc

+ +

Beta License: AGPL-3 Elabore/crm-tools

+

[ This file must be max 2-3 paragraphs, and is required.

+

The goal of this document is to explain quickly the features of this +module: “what” this module does and “what” it is for. ]

+

Example:

+

This module extends the functionality of … to support … and to allow +users to …

+

Table of contents

+ +
+

Use Cases / Context

+

[ This file is optional but strongly suggested to allow end-users to +evaluate the module’s usefulness in their context. ]

+

BUSINESS NEED: It should explain the “why” of the module:

+
    +
  • what is the business requirement that generated the need to develop +this module
    • +
  • in which context or use cases this module can be useful (practical +examples are welcome!).
    • +
+

APPROACH: It could also explain the approach to address the mentioned +need.

+

USEFUL INFORMATION: It can also inform on related modules:

+
    +
  • modules it depends on and their features
    • +
  • other modules that can work well together with this one
    • +
  • suggested setups where the module is useful (eg: multicompany, +multi-website)
    • +
+
+
+

Installation

+

[ This file must only be present if there are very specific installation +instructions, such as installing non-python dependencies. The audience +is systems administrators. ]

+

To install this module, you need to:

+
    +
  1. Do this …
    2. +
+
+
+

Configuration

+

[ This file is not always required; it should explain how to configure +the module before using it; it is aimed at users with administration +privileges.

+

Please be detailed on the path to configuration (eg: do you need to +activate developer mode?), describe step by step configurations and the +use of screenshots is strongly recommended.]

+

To configure this module, you need to:

+
    +
  • Go to App > Menu > Menu item
    • +
  • Activate boolean… > save
    • +
  • …
    • +
+
+
+

Usage

+

[ This file is required and contains the instructions on “how” to +use the module for end-users.

+

If the module does not have a visible impact on the user interface, just +add the following sentence:

+
+This module does not impact the user interface.
+

If that’s not the case, please make sure that every usage step is +covered and remember that images speak more than words!]

+

To use this module, you need to:

+
    +

  • Go to App > Menu > Menu item

    +

    insert screenshot!

    +
    • +

  • In “Contact” form, add a value to field xyz > save

    +

    insert screenshot!

    +
    • +

  • The value of xyz is now displayed in the list view.

    +

    insert screenshot!

    +
    • +
+
+
+

Known issues / Roadmap

+

[ Enumerate known caveats and future potential improvements. It is +mostly intended for end-users, and can also help potential new +contributors discovering new features to implement. ]

+
    +
  • …
    • +
+
+
+

Changelog

+

[ The change log. The goal of this file is to help readers understand +changes between version. The primary audience is end users and +integrators. Purely technical changes such as code refactoring must not +be mentioned here.

+

This file may contain ONE level of section titles, underlined with the ~ +(tilde) character. Other section markers are forbidden and will likely +break the structure of the README.rst or other documents where this +fragment is included. ]

+
+

11.0.x.y.z (YYYY-MM-DD)

+
    +
  • [BREAKING] Breaking changes come first. +(#70)
    • +
  • [ADD] New feature. (#74)
    • +
  • [FIX] Correct this. (#71)
    • +
+
+ +
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Elabore
    • +
+
+
+

Contributors

+ +
+
+

Other credits

+

[ This file is optional and contains additional credits, other than +authors, contributors, and maintainers. ]

+

The development of this module has been financially supported by:

+
    +
  • Company 1 name
    • +
  • Company 2 name
    • +
+
+
+

Maintainers

+

This module is part of the Elabore/crm-tools project on GitHub.

+

You are welcome to contribute.

+
+
+
+
+ +