DOC: Module Code Structure
@tobi-or-not-tobi is already working on this.
Since Mar 14, 2019.
- Dominant language
- HTML
- Stars
- 11
- Forks
- 22
- Avg merge
- 7d 3h
- Merged PRs (30d)
- 2
Description
If there is anything we want to say about the code structure of modules, let's add it to our coding guidelines (or another location, if that seems better).
The following text was in our coding guidelines, but was not accurate, so it has been removed. We can use this as the starting point for what to improve, if we wish to add back this info at a later point...
The code structure of each module should be consistent. For example, most modules have the following folders:
- a
storefolder that contains store-related code - a
facadefolder that contains all facade code for that particular module - an
occfolder that contains module-specific services that call the OCC APIs to communicate with the back end
The one exception is for UI components that are common to all modules, which are in storefrontlib/src/lib/ui/components.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.