From 24c1309bbffa7d3957f68d1decc418d2e855afec Mon Sep 17 00:00:00 2001 From: Florencia Frigieri <87654339+florenciafrigieri2@users.noreply.github.com> Date: Fri, 15 Mar 2024 10:31:09 -0300 Subject: [PATCH] Update CONTEXT.md We add more information about the context section --- template/module/readme/CONTEXT.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/template/module/readme/CONTEXT.md b/template/module/readme/CONTEXT.md index cdc297aa..096235a2 100644 --- a/template/module/readme/CONTEXT.md +++ b/template/module/readme/CONTEXT.md @@ -1,13 +1,16 @@ [ This file is optional but strongly suggested to allow end-users to evaluate the module's usefulness in their context. ] -It should explain the “why” of the module: - -- in which context or use cases this module can be useful (practical examples are welcome!). +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!). -It can also inform on related modules: +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)