Elgato_dark/void
1
0
Fork 0
mirror of https://github.com/voideditor/void synced 2026-05-23 17:38:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

contributing

Browse source
This commit is contained in:
Andrew Pareles 2025-01-24 15:02:16 -08:00 committed by GitHub
parent a3f145328b
commit 67c557b7b9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
CONTRIBUTING.md
View file

@ -1,18 +1,31 @@
# 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).
- 💫 Build new features - see [Issues](https://github.com/voideditor/void/issues).
- 💡 Make suggestions in our [Discord](https://discord.gg/RSNjgaugJs).
### 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.
<!-- ADD BLOG HERE
We wrote a [guide to working in VSCode].
-->
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).
Most of Void's code lives in the two folders called `void/`.
## Building Void
### a. Build Prerequisites - Mac
@ -121,20 +134,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.
<!-- ADD BLOG HERE
We wrote a [guide to working in VSCode].
-->
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).