diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 151badfc..c7ef8bae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,27 @@ # Contributing to Void - -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/`. +### 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! There are a few ways to contribute: -- ðŸ‘Ļ‍ðŸ’ŧ Build new features - see [Roadmap](https://github.com/orgs/voideditor/projects/2/views/3) and [Issues](https://github.com/voideditor/void/issues). +- ðŸ’Ŧ Complete items on the [Roadmap](https://github.com/orgs/voideditor/projects/2). - ðŸ’Ą Make suggestions in our [Discord](https://discord.gg/RSNjgaugJs). +- ðŸŠī Start new Issues - see [Issues](https://github.com/voideditor/void/issues). + + + +### Codebase Guide + +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. + + + +Most of Void's code lives in the two folders called `void/`. + @@ -121,20 +133,6 @@ Void's maintainers distribute Void on our website and in releases. If you'd like - 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. - -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 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). - - - diff --git a/README.md b/README.md index ca38d5b7..f1594fd4 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 the `announcements` channel), with 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/email) for Discord members (see the `announcements` channel), with a waitlist for our official release. If you're new, welcome! - 👋 [Discord](https://discord.gg/RSNjgaugJs)