Repository navigation
docs: make the repository legible to open-source readers, and license it #97
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
Merged
Merged
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
1b39bfd
chore: license the project under Apache-2.0
stone16 9d5a668
docs: extract the capability ledger into STATUS.md
stone16 209fe33
docs: add a contributor guide
stone16 1d0154d
docs: rewrite README for open-source readers
stone16 8d01cfe
docs: record ADR-0057..0060 activations in the status ledger
stone16 7556502
docs: assert individual copyright through a NOTICE file
stone16 5f95569
chore: apply Apache-2.0 to the three TypeScript packages
stone16 7accac5
docs: separate the conformance composition from the reject-all default
stone16 834e949
docs: reference version sources instead of restating them
stone16 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| # Contributing to ContextEngine | ||
|
|
||
| Thanks for taking the time to look at this project. | ||
|
|
||
| Before you write code, please read this page. ContextEngine holds a stricter | ||
| evidence bar than most repositories its size, and the difference is not style — | ||
| it is the point of the project. A contribution that adds a useful feature but | ||
| weakens an invariant will be declined. | ||
|
|
||
| ## The one rule that explains all the others | ||
|
|
||
| **Security is a veto, not a score.** | ||
|
|
||
| Three invariants must hold, and no feature benefit offsets a failure in any of | ||
| them: | ||
|
|
||
| - Unauthorized Evidence leaked = **0** | ||
| - Wrong-Organization effect = **0** | ||
| - Missing tenant context = **fail closed, always** | ||
|
|
||
| A second rule follows from the first: **a capability is not "done" because it | ||
| runs — it is done when executable evidence proves its exact boundary.** | ||
| Anything unproven stays labeled `NOT_ACTIVE`, including in the service's own | ||
| `/health` response. Please do not "helpfully" remove a `NOT_ACTIVE` marker; it | ||
| is load-bearing. See [STATUS.md](./STATUS.md). | ||
|
|
||
| ## Before you start | ||
|
|
||
| 1. **Check the issue tracker.** Issues and PRDs live in | ||
| [GitHub Issues](https://github.com/stone16/context-engine/issues). Read the | ||
| full body, labels, and comments before acting on an existing issue. | ||
| 2. **Open an issue before a large PR.** External pull requests are not a triage | ||
| surface for feature requests — an unsolicited large PR is likely to be | ||
| declined on scope alone, however good the code is. | ||
| 3. **Read the domain glossary.** [CONTEXT.md](./CONTEXT.md) is the repository's | ||
| authority on terms like `CandidateRef`, `AuthorizedProjection`, | ||
| `SourceAclEvidence`, and `TrustedDeliveryContext`. Using these words loosely | ||
| in code or review is a real source of bugs here. | ||
|
|
||
| ### Triage labels | ||
|
|
||
| | Label | Meaning | | ||
| |---|---| | ||
| | `needs-triage` | Maintainer evaluation is required | | ||
| | `needs-info` | Waiting for reporter information | | ||
| | `ready-for-agent` | Fully specified and AFK-agent ready | | ||
| | `ready-for-human` | Human implementation or judgment is required | | ||
| | `wontfix` | The work will not be actioned | | ||
|
|
||
| ## Development setup | ||
|
|
||
| See [Quick start](./README.md#quick-start) in the README for prerequisites | ||
| (Python 3.13, uv, Node 22.12.0, Docker). | ||
|
|
||
| ```bash | ||
| make install | ||
| make db-up | ||
| ``` | ||
|
|
||
| ## The verification contract | ||
|
|
||
| **Never claim a change works without running the commands and reading the real | ||
| output.** Fabricated or assumed verification output is the one contribution | ||
| behavior that will get a PR closed without further review. | ||
|
|
||
| Run the full gate — the same one CI runs — before opening a PR: | ||
|
|
||
| ```bash | ||
| make check | ||
| ``` | ||
|
|
||
| `make check` requires `make db-up` first, and covers: build, Ruff, strict mypy, | ||
| TypeScript typecheck, OpenAPI freeze check, SDK generate/build/test/pack, | ||
| ActionPlane and BotDelivery build and tests, Python unit tests, the security | ||
| catalog, the process smoke suite, the real-PostgreSQL integration harness, and | ||
| the M0 security gate. | ||
|
|
||
| For faster inner loops: | ||
|
|
||
| ```bash | ||
| make lint # Ruff | ||
| make typecheck # strict mypy + TS | ||
| make test # Python unit tests | ||
| make integration # real-PostgreSQL integration/security harness | ||
| make security-gate # M0 security veto gate | ||
| ``` | ||
|
|
||
| When you are done, stop the harness: | ||
|
|
||
| ```bash | ||
| make db-down | ||
| ``` | ||
|
|
||
| ## Writing tests | ||
|
|
||
| Tests are not a coverage exercise here — they are the evidence the project | ||
| ships on. Two expectations go beyond the usual: | ||
|
|
||
| - **A test must encode the business invariant it protects,** not merely the | ||
| current behavior. If a test still passes after the meaningful rule changes, | ||
| it is a shallow test. | ||
| - **Runtime tests use the highest public seam available** — HTTP or the | ||
| generated SDK — and must prove the chain | ||
| `CandidateRef → AuthorizationKernel → AuthorizedProjection`. A test that lets | ||
| a raw candidate reach a content-bearing consumer is testing the wrong thing. | ||
|
|
||
| Negative cases matter as much as positive ones: cross-Organization, denied | ||
| same-Organization, nonexistent candidates, tampering, replay, expiry, and | ||
| concurrent losers should all be provably zero-effect. | ||
|
|
||
| ## Architectural boundaries | ||
|
|
||
| These are not preferences. Changes that cross them will be asked for an ADR | ||
| first, or declined. | ||
|
|
||
| - **The Runtime path is sealed, not merely wired.** No feature flag, alternate | ||
| composition, no-op dependency, or direct retriever-to-assembler path may | ||
| bypass the `AuthorizationKernel`, PackageBudget, provenance, or audit gates. | ||
| - **Authorization precedes anything content-bearing.** Indexes return | ||
| `CandidateRef` only. Hydration, reranking, relevance models, and assembly | ||
| accept `AuthorizedProjection` only. Every parent/neighbor expansion is | ||
| re-authorized. | ||
| - **`Weak` ACL evidence is never a fallback.** It is permitted only where a | ||
| source genuinely lacks finer-grained ACL semantics. A failed `Live` or | ||
| `Mirrored` check fails closed. | ||
| - **External effects go through `ActionPlane.prepare` then `perform`,** each | ||
| with its own org-scoped, audience- and payload-bound, one-shot ticket. Never | ||
| reuse a create ticket for an edit or send. | ||
| - **Index and cache filters never make authorization decisions.** | ||
| - **No secrets, `.env` values, or credentials in commits** — reference a single | ||
| live source. Do not hardcode volatile values (URLs, ports, versions) in prose; | ||
| point to their source of truth. | ||
|
|
||
| ### Zero code copying | ||
|
|
||
| The design draws on architectural study of **Dify**, **RAGFlow**, **MaxKB**, and | ||
| **Onyx**, limited to observable behavior, interface shape, test oracles, and | ||
| product workflows. **Do not copy code from them, in any amount.** Public | ||
| reference claims must trace to the | ||
| [evidence baseline](./docs/research/2026-07-19-four-public-repositories-evidence.md). | ||
| Research from outside this repository may inform your reasoning, but must never | ||
| be cited or linked as public provenance. | ||
|
|
||
| ## Architecture Decision Records | ||
|
|
||
| Any non-obvious decision is recorded as an ADR under | ||
| [`docs/decisions/`](./docs/decisions/README.md) — there are 60 of them, and they | ||
| are the authority on boundaries, dependency direction, forbidden shortcuts, and | ||
| revisit triggers. | ||
|
|
||
| Write a new ADR when your change alters a boundary, introduces a dependency | ||
| direction, or closes off an option that a future contributor might reasonably | ||
| want. Follow the numbering and shape of the most recent accepted ADRs. | ||
|
|
||
| ## Pull requests | ||
|
|
||
| **Commits.** One concern per commit. Use the prefixes already in the history: | ||
| `feat:`, `fix:`, `docs:`, `chore:`, `refactor:`, `style:`, or a domain prefix | ||
| such as `supply:`, `runtime:`, `delivery:`, `bot:`. | ||
|
|
||
| **Before you open the PR, confirm:** | ||
|
|
||
| - [ ] The change does what the issue asked, and edge cases are considered. | ||
| - [ ] `make check` passes, and you have the real output — not an assumption. | ||
| - [ ] Runtime tests prove `CandidateRef → AuthorizationKernel → | ||
| AuthorizedProjection`; no raw candidate reaches a content-bearing consumer. | ||
| - [ ] No secrets or volatile values baked into code or docs. | ||
| - [ ] Any non-obvious decision is recorded as an ADR. | ||
| - [ ] Capability claims match reality — anything unproven is still `NOT_ACTIVE`, | ||
| and [STATUS.md](./STATUS.md) is updated if a boundary moved. | ||
|
|
||
| **In the PR description**, state plainly what you verified and what you did not. | ||
| If you skipped something, say so. Surfacing uncertainty is always preferred to | ||
| hiding it. | ||
|
|
||
| ## Scope discipline | ||
|
|
||
| Touch only what the task requires. Please do not "improve" adjacent code, | ||
| comments, or formatting in the same PR — it makes the security-relevant diff | ||
| harder to review, which is a real cost in this repository. Match existing | ||
| conventions even where you would have chosen differently; if you think a | ||
| convention is harmful, raise it as its own issue rather than forking it | ||
| silently. | ||
|
|
||
| ## License | ||
|
|
||
| By contributing, you agree that your contributions are licensed under the | ||
| [Apache License 2.0](./LICENSE). | ||
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,202 @@ | ||
|
|
||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
|
|
||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
|
|
||
| APPENDIX: How to apply the Apache License to your work. | ||
|
|
||
| To apply the Apache License to your work, attach the following | ||
| boilerplate notice, with the fields enclosed by brackets "[]" | ||
| replaced with your own identifying information. (Don't include | ||
| the brackets!) The text should be enclosed in the appropriate | ||
| comment syntax for the file format. We also recommend that a | ||
| file or class name and description of purpose be included on the | ||
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright [yyyy] [name of copyright owner] | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
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.
Uh oh!
There was an error while loading. Please reload this page.