Skip to content

docs(contributing): keep docs interlinked and DRY #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markholdex merged 2 commits into from
Apr 23, 2026
Merged

docs(contributing): keep docs interlinked and DRY #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16c2e8e
docs(contributing): keep docs interlinked and avoid content duplication
zolotokrylin Apr 23, 2026
7f32c9d
fix: markdown formatting
zolotokrylin Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,8 @@ For detailed instructions on why and how to sign your commits refer to
### Scoping

> [!TIP]
> Here's a [good resource](https://youtu.be/bmSAYlu0NcY?si=2lLQeY1PGCY9tcvX) on software design philosophy.
> Here's a [good resource](https://youtu.be/bmSAYlu0NcY?si=2lLQeY1PGCY9tcvX) on
> software design philosophy.

When planning the scope of work, make sure you
[keep PRs small](https://artsy.github.io/blog/2021/03/09/strategies-for-small-focused-pull-requests/).
Expand All @@ -203,6 +204,13 @@ When introducing functional changes, cross-check the README and update it in the
same PR. If your change affects anything documented there — setup steps,
environment requirements, file references — the README must stay in sync.

When adding new documentation files, ensure they are reachable via interlinking
from the root entry point. Do not create orphaned files.

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.

### Naming

> [!NOTE]
Expand Down Expand Up @@ -250,7 +258,8 @@ _"What am I building?"_

#### Design PRs

Design PRs use `docs(ui)` as the type and scope. e.g.: `docs(ui): design table component`
Design PRs use `docs(ui)` as the type and scope. e.g.:
`docs(ui): design table component`

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

If there isn't an existing DESIGN.md file, create one and link it from README.md.
If there isn't an existing DESIGN.md file, create one and link it from
README.md.

### PR Lifecycle

Expand Down
6 changes: 3 additions & 3 deletions docs/REFERRAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Once the eligibility conditions are met, reach out to your lead to claim the
reward.

> [!IMPORTANT]
> This referral program applies unless there is a separate commercial
> engagement between Holdex and the contributor, in which case referral terms
> are governed by that agreement instead.
> This referral program applies unless there is a separate commercial engagement
> between Holdex and the contributor, in which case referral terms are governed
> by that agreement instead.
3 changes: 2 additions & 1 deletion docs/TRIAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ trial and follow our team's principles.

## I don't have access to open a PR in the repository. What do I do?

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

## What is the trial duration?

Expand Down
Loading