diff --git a/.github/workflows/fork-health.yml b/.github/workflows/fork-health.yml new file mode 100644 index 0000000..a2b2d83 --- /dev/null +++ b/.github/workflows/fork-health.yml @@ -0,0 +1,22 @@ +name: Fork Health + +on: + workflow_dispatch: + push: + paths: + - "docs/FORK_AND_RELEASE.md" + - "scripts/verify-fork.sh" + - ".github/workflows/fork-health.yml" + +jobs: + verify-fork-wiring: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Verify fork wiring + run: | + chmod +x scripts/verify-fork.sh + scripts/verify-fork.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + 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 diff --git a/README.md b/README.md index f191465..5b7d053 100644 --- a/README.md +++ b/README.md @@ -1 +1,68 @@ -# Open-Cursor \ No newline at end of file +# Open Code + +Open Code is an **open, memory-native coding editor** intended to be built from a Code-OSS lineage and released as a public product. + +## Current Status + +This repository is currently a **planning/bootstrap repo**. It is not yet a full Code-OSS code fork with product changes. + +## Fork Model (Practical) + +You can be a fork in two valid ways: + +1. **Connected fork (recommended):** GitHub fork relationship to `microsoft/vscode` with an `upstream` remote for easy sync. +2. **Detached/independent fork:** You start from Code-OSS history and maintain your own brand/repo without a permanent `upstream` remote. + +OpenShift-style precedent: projects can begin from an upstream codebase, heavily diverge, and still remain a legitimate downstream distribution with independent release governance. + +## Product Direction + +Treat this as three first-class systems: + +1. **Editor Shell** +2. **Agent Runtime** +3. **Memory Infrastructure** + +Memory is infrastructure, not a chat add-on. + +## Must-Have UX + +- Inline suggestions in-editor. +- Agent-driven file edits. +- Review controls to accept/reject changes **line-by-line** and **logic-by-logic**. +- Undoable, transparent agent actions with clear reasoning/context. + +## Memory Scopes + +- `session` +- `repo` +- `host` +- `user` +- `credential_ref` (metadata only; never plaintext secrets) + +## Security Baseline + +- Secrets in OS keychain / secure vaults only. +- Memory stores references/metadata, not secret values. +- Audit trail for privileged credential usage. + +## Architecture Stack + +- **Base:** Code-OSS lineage +- **Language:** TypeScript-first +- **Desktop:** Electron +- **Store:** SQLite for structured metadata + memory graph +- **Retrieval:** symbolic + vector hybrid +- **Models:** local open-weights by default, API optional via provider abstraction + +## License + +Open Code is licensed under **Apache License 2.0** (`LICENSE`). + +## Next Steps + +1. Decide fork mode: connected (`upstream`) vs detached (manual sync cadence). +2. Import/sync Code-OSS history as baseline. +3. Build extension-first prototype for agent/memory loop. +4. Promote validated pieces into product-native surfaces. +5. Ship reproducible, signed releases. diff --git a/docs/FORK_AND_RELEASE.md b/docs/FORK_AND_RELEASE.md new file mode 100644 index 0000000..ad742fd --- /dev/null +++ b/docs/FORK_AND_RELEASE.md @@ -0,0 +1,60 @@ +# Fork + Release Guide + +This guide covers both ways to launch Open Code from Code-OSS while keeping it releasable. + +## Option A — Connected Fork (recommended for easier sync) + +1. Create a GitHub fork from `microsoft/vscode`. +2. Keep `origin` as your repo and add: + +```bash +git remote add upstream https://github.com/microsoft/vscode.git +git fetch upstream +``` + +3. Create your main product branch from upstream: + +```bash +git checkout -b open-code/main upstream/main +git push -u origin open-code/main +``` + +4. Periodically sync: + +```bash +git fetch upstream +git checkout open-code/main +git rebase upstream/main +git push --force-with-lease origin open-code/main +``` + +## Option B — Detached/Independent Fork + +Use this if you do **not** want permanent `upstream` wiring. + +1. Import Code-OSS history into your repository baseline. +2. Remove or avoid `upstream` remote. +3. Pull upstream changes on your own cadence (manual mirror/import). + +You are still a downstream fork in engineering terms as long as your code lineage is from Code-OSS. + +## Release Baseline + +Before public release: + +- reproducible build docs +- signed binaries where required +- changelog + attribution discipline +- security policy and disclosure process +- extension strategy (Open VSX first) +- explicit credential handling policy (no plaintext secrets) + +## Definition of Releasable + +Open Code is releasable when: + +- Code-OSS lineage is documented, +- branch governance is clear, +- agent edit/review loop is stable, +- memory behavior is explicit and revocable, +- desktop artifacts are reproducible and publishable. diff --git a/scripts/verify-fork.sh b/scripts/verify-fork.sh new file mode 100755 index 0000000..40a4c1e --- /dev/null +++ b/scripts/verify-fork.sh @@ -0,0 +1,31 @@ +#!/usr/bin/env bash +set -euo pipefail + +echo "== Open Code lineage verification ==" + +if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then + echo "❌ Not inside a git repository" + exit 1 +fi + +if git remote | grep -qx upstream; then + upstream_url="$(git remote get-url upstream)" + echo "ℹ️ Found upstream remote: $upstream_url" + + if [[ "$upstream_url" == *"github.com/microsoft/vscode"* ]]; then + echo "✅ Upstream points to microsoft/vscode" + else + echo "⚠️ Upstream exists but is not microsoft/vscode" + fi + + if git merge-base --is-ancestor upstream/main HEAD 2>/dev/null; then + echo "✅ HEAD contains upstream/main ancestry" + else + echo "⚠️ Unable to confirm upstream/main ancestry from local refs" + fi +else + echo "ℹ️ No upstream remote configured (detached fork mode is allowed)" + echo "⚠️ Ensure Code-OSS lineage is documented in release notes/repo docs" +fi + +echo "✅ Verification completed"