Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.31 KB

CODING.md

File metadata and controls

33 lines (23 loc) · 1.31 KB
Raw

Coding guide

  • Please wrap long lines using newline characters, so that the git line diffs result in fewer merge conflicts.

  • Don't change things unnecessarily (e.g. if you reindent an entire paragraph when you're fixing a single typo, then you unnecessarily increase the probability for merge conflicts).

  • Prefer npm ci instead of npm install, and only include the package-lock.json file in your commit when you know what you are doing. For further explanation see this stackoverflow question.

Swarm vs. swarm, and uppercasing in general

Swarm, with a capital, refers to the project and the main network, e.g.:

Swarm uses the content hashes as addresses

As of today, the Swarm mainnet consists of n number of nodes

swarm, in lower case, refers to a swarm of bee nodes. Note that the Bee client supports running/forming multiple Swarm swarms, i.e. you can even run your own!

when your node joins the designated swarm

Bee, with a capital, refers to a specific bee client, written in the go programming language, while bee, in lower case, refers to any worker that can join a swarm (e.g. any client implementation that speaks the Swarm protocol).