|
1 | 1 | # Coding guide |
2 | 2 |
|
3 | | -- Please wrap long lines using `newline` characters, so that the `git` |
4 | | - line diffs result in fewer merge conflicts. |
| 3 | +- Write each sentence on its own line: put a newline after every sentence, rather than hard-wrapping lines at a fixed column width. |
| 4 | + This keeps `git` line diffs small and produces fewer merge conflicts, without the awkward mid-sentence breaks that fixed-width wrapping causes. |
5 | 5 |
|
6 | | -- Don't change things unnecessarily (e.g. if you reindent an entire |
7 | | - paragraph when you're fixing a single typo, then you unnecessarily |
8 | | - increase the probability for merge conflicts). |
| 6 | +- 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). |
9 | 7 |
|
10 | | -- Prefer `npm ci` instead of `npm install`, and only include the |
11 | | - `package-lock.json` file in your commit when you know what you are |
12 | | - doing. For further explanation see this |
13 | | - [stackoverflow question](https://stackoverflow.com/questions/48524417/should-the-package-lock-json-file-be-added-to-gitignore). |
| 8 | +- 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. |
| 9 | + For further explanation see this [stackoverflow question](https://stackoverflow.com/questions/48524417/should-the-package-lock-json-file-be-added-to-gitignore). |
14 | 10 |
|
15 | 11 | ## Swarm vs. swarm, and uppercasing in general |
16 | 12 |
|
17 | | -`Swarm`, with a capital, refers to the project and the main network, |
18 | | -e.g.: |
| 13 | +`Swarm`, with a capital, refers to the project and the main network, e.g.: |
19 | 14 |
|
20 | 15 | > Swarm uses the content hashes as addresses |
21 | 16 |
|
22 | 17 | > As of today, the Swarm mainnet consists of `n` number of nodes |
23 | 18 |
|
24 | | -`swarm`, in lower case, refers to a swarm of bee nodes. Note that the |
25 | | -Bee client supports running/forming multiple Swarm swarms, i.e. you |
26 | | -can even run your own! |
| 19 | +`swarm`, in lower case, refers to a swarm of bee nodes. |
| 20 | +Note that the Bee client supports running/forming multiple Swarm swarms, i.e. you can even run your own! |
27 | 21 |
|
28 | 22 | > when your node joins the designated swarm |
29 | 23 |
|
30 | | -[`Bee`](https://github.com/ethersphere/bee), with a capital, refers to |
31 | | -a specific bee client, written in the `go` programming language, while |
32 | | -`bee`, in lower case, refers to any worker that can join a swarm |
33 | | -(e.g. any client implementation that speaks the Swarm protocol). |
| 24 | +[`Bee`](https://github.com/ethersphere/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). |
0 commit comments