-
Notifications
You must be signed in to change notification settings - Fork 0
Rewrite RankWeave README for customers and operators #40
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.
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
Open
seonghobae
wants to merge
7
commits into
main
Choose a base branch
from
cursor/customer-readme-e23b
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+395
−442
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d6528a8
docs: rewrite README for customers and operators
cursoragent 36dfc85
docs: keep source install operator-facing
cursoragent f801c13
docs: make README install section PyPI-honest
seonghobae 41c618f
docs: forward-reference post-0.1.0 APIs from the install section
seonghobae e0663e2
Merge remote-tracking branch 'origin/main' into pr40-resolve
seonghobae 55cf50c
Merge origin/main into cursor/customer-readme-e23b (restack PR #40)
seonghobae 933b675
docs: align verified test evidence
seonghobae File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Contributing to RankWeave | ||
|
|
||
| This file is for maintainers, reviewers, and automation that change the | ||
| RankWeave source tree. Operators who only need to install, run, or call the | ||
| published contract should start at [README.md](README.md). | ||
|
|
||
| RankWeave is a leaf product. It must keep working as a standalone package and | ||
| as a published dependency. [Naruon](https://github.com/ContextualWisdomLab/naruon) | ||
| may call RankWeave through that published contract; do not treat that hub-and-leaf | ||
| composition as a layering violation, and do not make a Naruon checkout a | ||
| prerequisite for RankWeave development or tests. | ||
|
|
||
| ## Local development | ||
|
|
||
| ```bash | ||
| pip install -e ".[dev]" | ||
| python -m ruff check . | ||
| python -m coverage run -m pytest -q | ||
| python -m coverage report | ||
| python -m pip wheel . --no-deps --wheel-dir dist | ||
| ``` | ||
|
|
||
| Production modules require complete public docstrings and 100% statement and | ||
| branch coverage. Runtime code may import only the Python standard library. | ||
|
|
||
| Follow [AGENTS.md](AGENTS.md) and [ARCHITECTURE.md](ARCHITECTURE.md). | ||
| `AGENTS.md` is a reviewed agent-control file; only an explicit maintainer pull | ||
| request may change it. | ||
|
|
||
| ## Release metadata | ||
|
|
||
| A release updates `pyproject.toml`, `rankweave.__version__`, the expected | ||
| version test, and `CHANGELOG.md` together. See [docs/releasing.md](docs/releasing.md). | ||
|
|
||
| ## Hourly governed development loop | ||
|
|
||
| The default branch runs an hourly workflow at minute 17: | ||
|
|
||
| `PR review/merge scan → review-feedback repair → exact-head revalidation → one | ||
| bounded buyer-visible product proposal when the governed PR queue is empty`. | ||
|
|
||
| PR inspection, review repair, and merge decisions use immutable reusable | ||
| workflows from the organization's central `.github` repository. The local | ||
| product stage uses a hash-pinned OpenCode binary with the official NVIDIA | ||
| provider and `NVIDIA_NIM_API_KEY`; it does not use GitHub Copilot Agent Tasks or | ||
| alter the existing review-agent credential path. | ||
|
|
||
| The workflow first permits edits only to tests and a design specification, then | ||
| runs pytest without network or inherited credentials and requires a genuine | ||
| failed test. Only then may the agent implement one bounded production change. | ||
| `AGENTS.md`, workflow, ownership, security, environment, and repository-control | ||
| files remain maintainer-owned and outside autonomous scope. Ruff, the complete | ||
| tests, 100% line/branch coverage, wheel build, offline installation, import | ||
| smoke, and `pip check` run in a network-isolated process. | ||
|
|
||
| Before requesting the short-lived OIDC-derived GitHub App token, the workflow | ||
| rechecks both the open-PR queue and exact `main` SHA. It repeats both checks | ||
| immediately before opening one PR. Generated work is never self-approved, | ||
| merged, published, or released. | ||
|
|
||
| The credential, sandbox, failure, and operating contracts live in | ||
| [Hourly commercialization loop](docs/operations/hourly-commercialization-loop.md). | ||
| Do not document that loop in the customer README. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 CHANGELOG overstates passing-test count
The rewritten Changed entry claims the suite
re-verified at 664 passed. The prior count was 661 and this PR adds only two tests (test_readme_audience.py), giving 663, which is also the number in the PR's own test plan. The 664 figure is off by one.Was this helpful? React with 👍 or 👎 to provide feedback.