From 6970ec9fd2185e3ac2f64cc652fdb3e1c1ee6042 Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 00:54:01 -0800 Subject: [PATCH 1/9] contrib --- CONTRIBUTING.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb0e5871..c553fa65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,8 @@ There are a few ways to contribute: - 👨‍💻 Build new features - see [Issues](https://github.com/voideditor/void/issues). - 💡 Make suggestions in our [Discord](https://discord.gg/RSNjgaugJs). -- ⭐️ If you want to build your AI tool into Void, feel free to get in touch! It's very easy to extend Void, and the UX you create will be much more natural than a VSCode Extension. +If you'd like to get started developing Void, feel free to follow the steps below to build Void and do PRs. Void's code mostly lives in `src/vs/workbench/contrib/void/` and `src/vs/platform/void/`. @@ -111,7 +111,7 @@ workspace/ ``` ### Distributing -We have a few scripts to convert `Mac .app -> .dmg`, `Windows folder -> .exe`, and `Linux folder -> appimage` for distribution. Let us know if you'd like access to them. +Void's maintainers distribute Void on our website and in releases. If you'd like to see the scripts to convert `Mac .app -> .dmg`, `Windows folder -> .exe`, and `Linux folder -> appimage` for distribution, feel free to reach out. ## Pull Request Guidelines @@ -121,6 +121,21 @@ We have a few scripts to convert `Mac .app -> .dmg`, `Windows folder -> .exe`, a - Please don't use AI to write your PR 🙂 +## Codebase Guide + +We highly recommend reading [this](https://github.com/microsoft/vscode/wiki/Source-Code-Organization) article on VSCode's sourcecode organization. + + + +For some misc useful links on VSCode we've put together, see [`VOID_USEFUL_LINKS.md`](https://github.com/voideditor/void/blob/main/VOID_USEFUL_LINKS.md). + + + + + + - -## References - -For some useful links we've compiled on VSCode, see [`VOID_USEFUL_LINKS.md`](https://github.com/voideditor/void/blob/main/VOID_USEFUL_LINKS.md). From 7891a908ffe50737b62afc1159d8d0b9ac7c7ea5 Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 00:55:22 -0800 Subject: [PATCH 2/9] links --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2db5e0b5..efbc1456 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Void is the open-source Cursor alternative. -This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/) for Discord members, and have a waitlist for our official release. If you're new, welcome! +This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/) for Discord members, and we have a waitlist for our official release. If you're new, welcome! - 👋 [Discord](https://discord.gg/RSNjgaugJs) @@ -24,11 +24,9 @@ This repo contains the full sourcecode for Void. We are currently in [open beta] ## Contributing -1. We host weekly contributing meetups in our Discord channel. Feel free to attend! +1. To get started developing Void, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md). -2. To get started developing, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md). - -3. To suggest a new feature, please create a new [GitHub Issue](https://github.com/voideditor/void/issues). +2. Feel free to attend a weekly meeting in our Discord channel. ## Reference From 326e75eb45271b79dbeacdac63cca145d8326081 Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 00:57:57 -0800 Subject: [PATCH 3/9] minor --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index efbc1456..55b41123 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,9 @@ This repo contains the full sourcecode for Void. We are currently in [open beta] 1. To get started developing Void, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md). -2. Feel free to attend a weekly meeting in our Discord channel. +2. Feel free to attend a weekly meeting in our Discord channel! + +3. We're open to collaborations of all types - just reach out. ## Reference From 198f04d87a90053149ab9624768ff0274208af69 Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 01:04:08 -0800 Subject: [PATCH 4/9] minor --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c553fa65..c9738f76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,14 +3,14 @@ Welcome! 👋 This is the official guide on how to contribute to Void. We want to make it as easy as possible to contribute, so if you have any questions or comments, reach out via email or discord! +If you'd like to get started developing Void, feel free to follow the steps below on building Void yourself and doing a PR. +Void's code mostly lives in `src/vs/workbench/contrib/void/` and `src/vs/platform/void/`. There are a few ways to contribute: - 👨‍💻 Build new features - see [Issues](https://github.com/voideditor/void/issues). - 💡 Make suggestions in our [Discord](https://discord.gg/RSNjgaugJs). -If you'd like to get started developing Void, feel free to follow the steps below to build Void and do PRs. -Void's code mostly lives in `src/vs/workbench/contrib/void/` and `src/vs/platform/void/`. ## Building Void @@ -125,11 +125,13 @@ Void's maintainers distribute Void on our website and in releases. If you'd like We highly recommend reading [this](https://github.com/microsoft/vscode/wiki/Source-Code-Organization) article on VSCode's sourcecode organization. +We are currently putting together our own articles on VSCode and Void's sourcecode organization. The best way to get this information right now is by attending a weekly meeting. + -For some misc useful links on VSCode we've put together, see [`VOID_USEFUL_LINKS.md`](https://github.com/voideditor/void/blob/main/VOID_USEFUL_LINKS.md). +For some miscellaneous useful links on VSCode we've put together, see [`VOID_USEFUL_LINKS.md`](https://github.com/voideditor/void/blob/main/VOID_USEFUL_LINKS.md). From c2f358bd5e569956f80fd970162387236132d903 Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 01:18:50 -0800 Subject: [PATCH 5/9] #announcements --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 55b41123..ca12db5a 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Void is the open-source Cursor alternative. -This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/) for Discord members, and we have a waitlist for our official release. If you're new, welcome! +This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/) for Discord members (`#announcements`), and we have a waitlist for our official release. If you're new, welcome! - 👋 [Discord](https://discord.gg/RSNjgaugJs) @@ -24,11 +24,12 @@ This repo contains the full sourcecode for Void. We are currently in [open beta] ## Contributing -1. To get started developing Void, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md). -2. Feel free to attend a weekly meeting in our Discord channel! +2. To get started developing Void, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md). -3. We're open to collaborations of all types - just reach out. +3. Feel free to attend a weekly meeting in our Discord channel! + +4. We're open to collaborations of all types - just reach out. ## Reference From d54ccff4a256d83cbc4b977cdaa5b0c04e79bd65 Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 02:30:06 -0800 Subject: [PATCH 6/9] see --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ca12db5a..f8eedda4 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Void is the open-source Cursor alternative. -This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/) for Discord members (`#announcements`), and we have a waitlist for our official release. If you're new, welcome! +This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/) for Discord members (see `#announcements`), and we have a waitlist for our official release. If you're new, welcome! - 👋 [Discord](https://discord.gg/RSNjgaugJs) From 151cdb13e617294cd6b3478a1abd2b043b7dab1b Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 02:56:56 -0800 Subject: [PATCH 7/9] add roadmap --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9738f76..3d73f87f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ Void's code mostly lives in `src/vs/workbench/contrib/void/` and `src/vs/platfor There are a few ways to contribute: -- 👨‍💻 Build new features - see [Issues](https://github.com/voideditor/void/issues). +- 👨‍💻 Build new features - see [Roadmap](https://github.com/orgs/voideditor/projects/2/views/3) or [Issues](https://github.com/voideditor/void/issues). - 💡 Make suggestions in our [Discord](https://discord.gg/RSNjgaugJs). @@ -117,7 +117,7 @@ Void's maintainers distribute Void on our website and in releases. If you'd like - Please submit a pull request once you've made a change. -- No need to submit an Issue unless you're creating a new feature. +- No need to submit an Issue unless you're creating a new feature that might involve multiple PRs. - Please don't use AI to write your PR 🙂 From 7e5cc27349d6b7d0b6eb5da6b68bfe63934a87c5 Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 03:08:50 -0800 Subject: [PATCH 8/9] tes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8eedda4..e729ede4 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Void is the open-source Cursor alternative. -This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/) for Discord members (see `#announcements`), and we have a waitlist for our official release. If you're new, welcome! +This repo contains the full sourcecode for Void. We are currently in [open beta](https://voideditor.com/) for Discord members (see `#announcements` to download), and we have a waitlist for our official release. If you're new, welcome! - 👋 [Discord](https://discord.gg/RSNjgaugJs) From 2aec37fc5780ee28483156e7e31544e9922804de Mon Sep 17 00:00:00 2001 From: Andrew Pareles <43356051+andrewpareles@users.noreply.github.com> Date: Wed, 22 Jan 2025 03:09:18 -0800 Subject: [PATCH 9/9] numbering --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e729ede4..613b772f 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,11 @@ This repo contains the full sourcecode for Void. We are currently in [open beta] ## Contributing -2. To get started developing Void, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md). +1. To get started developing Void, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md). -3. Feel free to attend a weekly meeting in our Discord channel! +2. Feel free to attend a weekly meeting in our Discord channel! -4. We're open to collaborations of all types - just reach out. +3. We're open to collaborations of all types - just reach out. ## Reference