|
| 1 | +========== |
| 2 | +Vcp Github |
| 3 | +========== |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:086596db3dcb4fa7565fc97cf01ccd22449731243622d4587a1f609eab8bc121 |
| 11 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 12 | +
|
| 13 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png |
| 14 | + :target: https://odoo-community.org/page/development-status |
| 15 | + :alt: Beta |
| 16 | +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png |
| 17 | + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
| 18 | + :alt: License: AGPL-3 |
| 19 | +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fversion--control--platform-lightgray.png?logo=github |
| 20 | + :target: https://github.com/OCA/version-control-platform/tree/18.0/vcp_github |
| 21 | + :alt: OCA/version-control-platform |
| 22 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 23 | + :target: https://translation.odoo-community.org/projects/version-control-platform-18-0/version-control-platform-18-0-vcp_github |
| 24 | + :alt: Translate me on Weblate |
| 25 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 26 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/version-control-platform&target_branch=18.0 |
| 27 | + :alt: Try me on Runboat |
| 28 | + |
| 29 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 30 | + |
| 31 | +[ This file must be max 2-3 paragraphs, and is required. |
| 32 | + |
| 33 | +The goal of this document is to explain quickly the features of this |
| 34 | +module: “what” this module does and “what” it is for. ] |
| 35 | + |
| 36 | +Example: |
| 37 | + |
| 38 | +This module extends the functionality of ... to support ... and to allow |
| 39 | +users to ... |
| 40 | + |
| 41 | +**Table of contents** |
| 42 | + |
| 43 | +.. contents:: |
| 44 | + :local: |
| 45 | + |
| 46 | +Use Cases / Context |
| 47 | +=================== |
| 48 | + |
| 49 | +[ This file is optional but strongly suggested to allow end-users to |
| 50 | +evaluate the module's usefulness in their context. ] |
| 51 | + |
| 52 | +BUSINESS NEED: It should explain the “why” of the module: |
| 53 | + |
| 54 | +- what is the business requirement that generated the need to develop |
| 55 | + this module |
| 56 | +- in which context or use cases this module can be useful (practical |
| 57 | + examples are welcome!). |
| 58 | + |
| 59 | +APPROACH: It could also explain the approach to address the mentioned |
| 60 | +need. |
| 61 | + |
| 62 | +USEFUL INFORMATION: It can also inform on related modules: |
| 63 | + |
| 64 | +- modules it depends on and their features |
| 65 | +- other modules that can work well together with this one |
| 66 | +- suggested setups where the module is useful (eg: multicompany, |
| 67 | + multi-website) |
| 68 | + |
| 69 | +Installation |
| 70 | +============ |
| 71 | + |
| 72 | +[ This file must only be present if there are very specific installation |
| 73 | +instructions, such as installing non-python dependencies. The audience |
| 74 | +is systems administrators. ] |
| 75 | + |
| 76 | +To install this module, you need to: |
| 77 | + |
| 78 | +1. Do this ... |
| 79 | + |
| 80 | +Configuration |
| 81 | +============= |
| 82 | + |
| 83 | +[ This file is not always required; it should explain **how to configure |
| 84 | +the module before using it**; it is aimed at users with administration |
| 85 | +privileges. |
| 86 | + |
| 87 | +Please be detailed on the path to configuration (eg: do you need to |
| 88 | +activate developer mode?), describe step by step configurations and the |
| 89 | +use of screenshots is strongly recommended.] |
| 90 | + |
| 91 | +To configure this module, you need to: |
| 92 | + |
| 93 | +- Go to *App* > Menu > Menu item |
| 94 | +- Activate boolean… > save |
| 95 | +- … |
| 96 | + |
| 97 | +Usage |
| 98 | +===== |
| 99 | + |
| 100 | +[ This file is required and contains the instructions on **“how”** to |
| 101 | +use the module for end-users. |
| 102 | + |
| 103 | +If the module does not have a visible impact on the user interface, just |
| 104 | +add the following sentence: |
| 105 | + |
| 106 | + This module does not impact the user interface. |
| 107 | + |
| 108 | +If that’s not the case, please make sure that every usage step is |
| 109 | +covered and remember that images speak more than words!] |
| 110 | + |
| 111 | +To use this module, you need to: |
| 112 | + |
| 113 | +- Go to *App* > Menu > Menu item |
| 114 | + |
| 115 | + *insert screenshot!* |
| 116 | + |
| 117 | +- In “Contact” form, add a value to field *xyz* > save |
| 118 | + |
| 119 | + *insert screenshot!* |
| 120 | + |
| 121 | +- The value of *xyz* is now displayed in the list view. |
| 122 | + |
| 123 | + *insert screenshot!* |
| 124 | + |
| 125 | +Known issues / Roadmap |
| 126 | +====================== |
| 127 | + |
| 128 | +[ Enumerate known caveats and future potential improvements. It is |
| 129 | +mostly intended for end-users, and can also help potential new |
| 130 | +contributors discovering new features to implement. ] |
| 131 | + |
| 132 | +- ... |
| 133 | + |
| 134 | +Changelog |
| 135 | +========= |
| 136 | + |
| 137 | +[ The change log. The goal of this file is to help readers understand |
| 138 | +changes between version. The primary audience is end users and |
| 139 | +integrators. Purely technical changes such as code refactoring must not |
| 140 | +be mentioned here. |
| 141 | + |
| 142 | +This file may contain ONE level of section titles, underlined with the ~ |
| 143 | +(tilde) character. Other section markers are forbidden and will likely |
| 144 | +break the structure of the README.rst or other documents where this |
| 145 | +fragment is included. ] |
| 146 | + |
| 147 | +11.0.x.y.z (YYYY-MM-DD) |
| 148 | +----------------------- |
| 149 | + |
| 150 | +- [BREAKING] Breaking changes come first. |
| 151 | + (`#70 <https://github.com/OCA/repo/issues/70>`__) |
| 152 | +- [ADD] New feature. (`#74 <https://github.com/OCA/repo/issues/74>`__) |
| 153 | +- [FIX] Correct this. (`#71 <https://github.com/OCA/repo/issues/71>`__) |
| 154 | + |
| 155 | +11.0.x.y.z (YYYY-MM-DD) |
| 156 | +----------------------- |
| 157 | + |
| 158 | +- ... |
| 159 | + |
| 160 | +Bug Tracker |
| 161 | +=========== |
| 162 | + |
| 163 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/version-control-platform/issues>`_. |
| 164 | +In case of trouble, please check there if your issue has already been reported. |
| 165 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 166 | +`feedback <https://github.com/OCA/version-control-platform/issues/new?body=module:%20vcp_github%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 167 | + |
| 168 | +Do not contact contributors directly about support or help with technical issues. |
| 169 | + |
| 170 | +Credits |
| 171 | +======= |
| 172 | + |
| 173 | +Authors |
| 174 | +------- |
| 175 | + |
| 176 | +* Dixmit |
| 177 | + |
| 178 | +Contributors |
| 179 | +------------ |
| 180 | + |
| 181 | +- Firstname Lastname email.address@example.org (optional company website |
| 182 | + url) |
| 183 | +- Second Person second.person@example.org (optional company website url) |
| 184 | + |
| 185 | +Other credits |
| 186 | +------------- |
| 187 | + |
| 188 | +[ This file is optional and contains additional credits, other than |
| 189 | +authors, contributors, and maintainers. ] |
| 190 | + |
| 191 | +The development of this module has been financially supported by: |
| 192 | + |
| 193 | +- Company 1 name |
| 194 | +- Company 2 name |
| 195 | + |
| 196 | +Maintainers |
| 197 | +----------- |
| 198 | + |
| 199 | +This module is maintained by the OCA. |
| 200 | + |
| 201 | +.. image:: https://odoo-community.org/logo.png |
| 202 | + :alt: Odoo Community Association |
| 203 | + :target: https://odoo-community.org |
| 204 | + |
| 205 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 206 | +mission is to support the collaborative development of Odoo features and |
| 207 | +promote its widespread use. |
| 208 | + |
| 209 | +This module is part of the `OCA/version-control-platform <https://github.com/OCA/version-control-platform/tree/18.0/vcp_github>`_ project on GitHub. |
| 210 | + |
| 211 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments