Skip to content

docs: add Zen of stdlib#11767

Open
kgryte wants to merge 2 commits intodevelopfrom
docs/zen-of-stdlib
Open

docs: add Zen of stdlib#11767
kgryte wants to merge 2 commits intodevelopfrom
docs/zen-of-stdlib

Conversation

@kgryte
Copy link
Copy Markdown
Member

@kgryte kgryte commented Apr 25, 2026

Description

What is the purpose of this pull request?

This pull request:

  • adds a new contributing document which outlines the design principles of stdlib, borrowing from the popular "Zen of" style originated by the Zen of Python.
  • in addition to the Zen, the document includes some additional notes which briefly elaborate on each of the expressed principles.

Related Issues

Does this pull request have any related issues?

No.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

Some back and forth with ChatGPT after writing a draft to get initial editorial feedback.

@stdlib-js/reviewers

@kgryte
docs: add Zen of stdlib
2dd7c7f 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@kgryte kgryte requested a review from a team April 25, 2026 03:47
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Apr 25, 2026
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 25, 2026
batpigandme
batpigandme previously approved these changes Apr 25, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@batpigandme batpigandme left a comment

Choose a reason for hiding this comment

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

This is great. I think certain aspects will have to be made a bit more concrete elsewhere, but this is not the place for that. Just one tiny grammatical nit.

Comment thread docs/contributing/zen_of_stdlib.md Outdated
@github-actions github-actions Bot mentioned this pull request Apr 25, 2026
Open
@kgryte @batpigandme
docs: fix punctuation
a961134 
Co-authored-by: Mara Averick <maraaverick@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@batpigandme batpigandme batpigandme left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

Documentation Improvements, additions, or changes to documentation. Needs Review A pull request which needs code review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kgryte @batpigandme @stdlib-bot