One of the best ways you can contribute to Zig is to start using it for a personal project. Here are some great examples:
- Oxid - arcade style game
- TM35-Metronome - tools for modifying and randomizing Pokémon games
- trOS - tiny aarch64 baremetal OS thingy
Without fail, these projects lead to discovering bugs and helping flesh out use cases, which lead to further design iterations of Zig. Importantly, each issue found this way comes with real world motivations, so it is easy to explain your reasoning behind proposals and feature requests.
Ideally, such a project will help you to learn new skills and add something to your personal portfolio at the same time.
Another way to contribute is to write about Zig, or speak about Zig at a conference, or do either of those things for your project which uses Zig. Here are some examples:
- Iterative Replacement of C with Zig
- The Right Tool for the Right Job: Redis Modules & Zig
- Writing a small ray tracer in Rust and Zig
Zig is a brand new language, with no advertising budget. Word of mouth is the only way people find out about the project, and the more people hear about it, the more people will use it, and the better chance we have to take over the world.
Please note that issues labeled Proposal but do not also have the Accepted label are still under consideration, and efforts to implement such a proposal have a high risk of being wasted. If you are interested in a proposal which is still under consideration, please express your interest in the issue tracker, providing extra insights and considerations that others have not yet expressed. The most highly regarded argument in such a discussion is a real world use case.
The issue label Contributor Friendly exists to help you find issues that are limited in scope and/or knowledge of Zig internals.
First, build the Stage 1 compiler as described in the Building section.
When making changes to the standard library, be sure to edit the files in the
std directory and not the installed copy in the build directory. If you add a
new file to the standard library, you must also add the file path in
CMakeLists.txt.
To test changes, do the following from the build directory:
- Run
make install(on POSIX) ormsbuild -p:Configuration=Release INSTALL.vcxproj(on Windows). bin/zig build test(on POSIX) orbin\zig.exe build test(on Windows).
That runs the whole test suite, which does a lot of extra testing that you likely won't always need, and can take upwards of 2 hours. This is what the CI server runs when you make a pull request.
To save time, you can add the --help option to the zig build command and
see what options are available. One of the most helpful ones is
-Dskip-release. Adding this option to the command in step 2 above will take
the time down from around 2 hours to about 6 minutes, and this is a good
enough amount of testing before making a pull request.
Another example is choosing a different set of things to test. For example,
test-std instead of test will only run the standard library tests, and
not the other ones. Combining this suggestion with the previous one, you could
do this:
bin/zig build test-std -Dskip-release (on POSIX) or
bin\zig.exe build test-std -Dskip-release (on Windows).
This will run only the standard library tests, in debug mode only, for all targets (it will cross-compile the tests for non-native targets but not run them).
When making changes to the compiler source code, the most helpful test step to
run is test-behavior. When editing documentation it is docs. You can find
this information and more in the --help menu.