SAP / SAP/spartacus-docs

DOC: Module Code Structure

Open
#83 0 comments 0 reactions 1 assignee View on GitHub

@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 store folder that contains store-related code
  • a facade folder that contains all facade code for that particular module
  • an occ folder 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.