Skip to content

doc: add notes on the design#3722

Merged
aignas merged 2 commits intomainfrom
chore.design.notes
Apr 21, 2026
Merged

doc: add notes on the design#3722
aignas merged 2 commits intomainfrom
chore.design.notes

Conversation

@aignas
Copy link
Copy Markdown
Collaborator

@aignas aignas commented Apr 21, 2026

Just to start a page on design notes to tell users better what they are getting.

@aignas aignas requested a review from rickeylev as a code owner April 21, 2026 04:18
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds 'Design' and 'Common misconceptions' sections to the README.md, providing details on platform support, dependency management, and performance scaling. The review feedback highlights several style and correctness issues, including lines exceeding the 100-character limit, grammatical errors, an incorrect PEP reference, and inconsistent capitalization of 'Bazel'.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment on lines +26 to +27
* The `py_binary`, `py_test` rules should scale to large monorepos and we work hard to minimize the work done during analysis and build phase. What is more, the space requirements for should be minimal, so we strive to use symlinks rather than extracting wheels at build time. This means that for different configurations of the same build, we are not extracting the wheel multiple times thus scaling better over the time. From `2.0` onwards we are creating a virtual env for each target by creating an actual minimal virtual environment using symlinks. We plan on creating the traditional `site-packages` layout in the future by default.
* Support for standards - we strive to first implement any standards needed within `rules_python` and this has resulted in a few PEPs supported within pure starlark - PEP440, PEP509.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

These lines exceed the 100-character limit. Additionally, line 26 contains grammatical errors ('space requirements for should be' and 'over the time'), and line 27 likely refers to PEP 508 (Dependency specification) rather than PEP 509 (Dictionary versioning).

References
  1. Max line length: 100. (link)

Comment thread README.md Outdated
Copy link
Copy Markdown
Collaborator

@rickeylev rickeylev left a comment

Choose a reason for hiding this comment

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

I did some heavy copy editing and rewrite. LGTM on the main topics, though.

@aignas aignas added this pull request to the merge queue Apr 21, 2026
Merged via the queue into main with commit afab5ed Apr 21, 2026
8 checks passed
@aignas aignas deleted the chore.design.notes branch April 21, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants