Skip to content

Commit 7f32c9d

Browse files
committed
fix: markdown formatting
1 parent 16c2e8e commit 7f32c9d

3 files changed

Lines changed: 16 additions & 9 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,8 @@ For detailed instructions on why and how to sign your commits refer to
187187
### Scoping
188188

189189
> [!TIP]
190-
> Here's a [good resource](https://youtu.be/bmSAYlu0NcY?si=2lLQeY1PGCY9tcvX) on software design philosophy.
190+
> Here's a [good resource](https://youtu.be/bmSAYlu0NcY?si=2lLQeY1PGCY9tcvX) on
191+
> software design philosophy.
191192
192193
When planning the scope of work, make sure you
193194
[keep PRs small](https://artsy.github.io/blog/2021/03/09/strategies-for-small-focused-pull-requests/).
@@ -203,9 +204,12 @@ When introducing functional changes, cross-check the README and update it in the
203204
same PR. If your change affects anything documented there — setup steps,
204205
environment requirements, file references — the README must stay in sync.
205206

206-
When adding new documentation files, ensure they are reachable via interlinking from the root entry point. Do not create orphaned files.
207+
When adding new documentation files, ensure they are reachable via interlinking
208+
from the root entry point. Do not create orphaned files.
207209

208-
Do not duplicate content across files. Each piece of information — procedures, templates, configuration steps — must live in exactly one place. Reference it from other docs rather than copying it.
210+
Do not duplicate content across files. Each piece of information — procedures,
211+
templates, configuration steps — must live in exactly one place. Reference it
212+
from other docs rather than copying it.
209213

210214
### Naming
211215

@@ -254,7 +258,8 @@ _"What am I building?"_
254258

255259
#### Design PRs
256260

257-
Design PRs use `docs(ui)` as the type and scope. e.g.: `docs(ui): design table component`
261+
Design PRs use `docs(ui)` as the type and scope. e.g.:
262+
`docs(ui): design table component`
258263

259264
Initiate a PR with a note in the DESIGN.md file detailing the addressed design
260265
aspects. Structure the design file with the following markup:
@@ -286,7 +291,8 @@ Example:
286291
- [[Bid Popup]](https://figma.com/your-design-file-url)
287292
```
288293

289-
If there isn't an existing DESIGN.md file, create one and link it from README.md.
294+
If there isn't an existing DESIGN.md file, create one and link it from
295+
README.md.
290296

291297
### PR Lifecycle
292298

docs/REFERRAL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ Once the eligibility conditions are met, reach out to your lead to claim the
1414
reward.
1515

1616
> [!IMPORTANT]
17-
> This referral program applies unless there is a separate commercial
18-
> engagement between Holdex and the contributor, in which case referral terms
19-
> are governed by that agreement instead.
17+
> This referral program applies unless there is a separate commercial engagement
18+
> between Holdex and the contributor, in which case referral terms are governed
19+
> by that agreement instead.

docs/TRIAL.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ trial and follow our team's principles.
5959
6060
## I don't have access to open a PR in the repository. What do I do?
6161

62-
Fork the repository and create a PR using a [Fork Strategy](https://gist.github.com/Chaser324/ce0505fbed06b947d962).
62+
Fork the repository and create a PR using a
63+
[Fork Strategy](https://gist.github.com/Chaser324/ce0505fbed06b947d962).
6364

6465
## What is the trial duration?
6566

0 commit comments

Comments
 (0)