Skip to content

docs: update unit-tests.md#303

Draft
s1m0n1au wants to merge 7 commits into
devfrom
docs/unit-test
Draft

docs: update unit-tests.md#303
s1m0n1au wants to merge 7 commits into
devfrom
docs/unit-test

Conversation

@s1m0n1au

Copy link
Copy Markdown
Contributor

No description provided.

@github-actions github-actions Bot added the Docs 📚 Improvements or additions to documentation label Nov 10, 2025
@kbventures kbventures requested a review from madcampos November 11, 2025 22:43
Comment thread docs/contributing-guide/testing/01-unit-tests.md
Comment thread docs/contributing-guide/testing/01-unit-tests.md Outdated
Comment thread docs/contributing-guide/testing/01-unit-tests.md Outdated
Comment thread docs/contributing-guide/testing/01-unit-tests.md Outdated
Comment thread docs/contributing-guide/testing/01-unit-tests.md Outdated
});
```

### DB helper functions

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again here, instead of dumping code that without context is meaningless, explain why the code is here, the pattern it represents, how the pattern is used in code, and when the person should use that pattern

});
```

> Note: Each test runs with **isolated storage** (enabled by default). Writes are undone after the test, so ordering is reliable.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: This should be more proeminent information and not a footnote. It completely changes how a user should think about the tests.

Comment thread docs/contributing-guide/testing/01-unit-tests.md Outdated
Comment thread docs/contributing-guide/testing/01-unit-tests.md Outdated
Comment thread docs/contributing-guide/testing/01-unit-tests.md Outdated
Co-authored-by: Marco Campos <me@madcampos.dev>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 13, 2025

Copy link
Copy Markdown

Deploying volunteer with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9e665ed
Status: ✅  Deploy successful!
Preview URL: https://1d4f07d0.volunteer-ekr.pages.dev
Branch Preview URL: https://docs-unit-test.volunteer-ekr.pages.dev

View logs

@madcampos madcampos left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After reading the text a second time, it sounds too much like AI slop.

The text is hollow and dry, in a bad way. Yes, it explains what things are and what they do, but it does so in a way a dictionary would do it, flat, empty, and without intentionality.

The documentation for a project should convey the reasoning for the decisions, the tradeoffs, the whys!

Please rewrite it yourself, with your own words, or if you use any LLM to write something review and edit it. Add your voice.

In the end of the day, any person can use an LLM and generate very decent text the same way, regardless of knowledge or life journey. Your voice is unique though, use it.

@s1m0n1au s1m0n1au requested a review from madcampos November 18, 2025 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs 📚 Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants