Skip to content

Commit f8a243c

Browse files
committed
chore: clarify sentence-per-line style guide
Signed-off-by: Yejin Kelly Joo <yejinkellyjoo@gmail.com>
1 parent 2593da7 commit f8a243c

2 files changed

Lines changed: 10 additions & 19 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The `prebuild` npm hook runs automatically before `build` and does three things,
5757

5858
## Content conventions (from CODING.md)
5959

60-
- **Wrap long lines** with newlines — keeps git diffs small and reduces merge conflicts.
60+
- **One sentence per line** — put a newline after every sentence instead of hard-wrapping at a fixed width; keeps git diffs small and reduces merge conflicts.
6161
- **Minimize unrelated edits** (e.g. don't reflow a whole paragraph to fix one typo) for the same reason.
6262
- **`Swarm` vs `swarm`**: capital `Swarm` = the project / main network; lowercase `swarm` = a swarm of bee nodes (Bee supports running multiple). Capital `Bee` = the Go client; lowercase `bee` = any Swarm-protocol client.
6363
- **Version bumps**: automated by the `update-openapi` workflow on each new stable Bee release (literal find-and-replace of the semver in the install docs). Only bump by hand for out-of-band corrections, across the whole `docs/` folder.

CODING.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,24 @@
11
# Coding guide
22

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.
55

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).
97

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).
1410

1511
## Swarm vs. swarm, and uppercasing in general
1612

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.:
1914

2015
> Swarm uses the content hashes as addresses
2116
2217
> As of today, the Swarm mainnet consists of `n` number of nodes
2318
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!
2721

2822
> when your node joins the designated swarm
2923
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

Comments
 (0)