Skip to content

Commit

Permalink
Merge pull request #608 from florenciafrigieri2/patch-1
Browse files Browse the repository at this point in the history
Update CONTEXT.md
  • Loading branch information
sbidoul committed Jun 25, 2024
2 parents 1faff6d + 24c1309 commit d3e09ae
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions template/module/readme/CONTEXT.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit d3e09ae

Please sign in to comment.