Tip
Consider joining our Discord Server, it's the best place to discuss use/development of ZestCode.
First off, thanks for taking the time to contribute! ZestCode relies on people like YOU to stay bug-free and updated.
Click Here to submit a bug report, feature request, or privately report a security concern.
Discussion and decision making regarding the development of ZestCode happens mostly on the ZestCode Discord server. Just asking questions, proposing new ideas, and sharing your thoughts make a positive impact.
Pull Requests (short form: "PRs") are used to make changes to ZestCode. The rest of this guide is dedicated to submitting a PR.
First, head on over to the ZestCode Issues Tab. Each title is prefixed with an emoji, which indicates the type of issue (see Gitmoji).
Each issue has a tag:
- triage - waiting on a maintainer to assign a tag
- sub-issue - this issue is part of a larger one
- blocked - this issue can't be worked on until other issue(s) are resolved
- in-progress - this issue is actively being worked on
- ready - this issue is ready to be worked on
You'll want to either submit a new issue which you might be able to work on, or you can select an existing issue marked "ready". Click Here for a list of all issues marked as "ready". Choose one you want to work on, we recommend something that doesn't sound too big or complicated for your first contribution.
Important
You'll need a GitHub account for this step.
Click here, then click the green button on the bottom right to create your fork, as shown in the image below.
After waiting a couple of seconds, you'll be redirected to your fork of ZestCode on GitHub.
Important
You'll need git, and Visual Studio Code for this step.
In Visual Studio Code, open the command palette with (ctrl+shift+p or command+shift+p). Type Git: Clone, and hit enter. Select Clone from GitHub, and then click <your_username_here>/ZestCode.
Important
You'll need Meson, and arm-none-eabi-gcc for this step.
In your project, open your terminal to set up and configure meson with this command:
meson setup --wipe --cross-file scripts/v5.ini build
Then, you can compile the project with this command:
meson compile -C build
Tip
You might have to restart your editor before Clangd starts working properly
Important
If you add any new source files, you will need to add them to meson.build
The project file structure is explained in STRUCTURE.md. Read through it so you know where you should make your changes. Details on the code style can be found in STYLEGUIDE.md.
You should commit changes regularly. This isn't a requirement, but it will make your life easier, especially for more complex PRs.
You should also be testing your code regularly, and write tests for it in the src/tests folder if needed.
Once you think your PR is ready to be reviewed, go to your fork on GitHub, and click the "contribute" button, as shown below.
Then, fill out the PR description template, and remember to prefix the title with a Gitmoji. Your PR might receive a review within a minutes, or hours. The longest you'll spend waiting is a week but this is rare.
Reviewers might request changes to the PR before it's merged. In fact, your PR might need several review cycles as we hold our code to a high standard. Once your PR is approved though, it will be merged shortly.
And that's it! thanks again for taking the time to contribute.