Skip to content
Snippets Groups Projects
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.md 14.88 KiB

Contributing to Weston

Finding something to work on

Weston's development is tracked on GitLab. In addition to reviewing code submissions (see below), we use the issue tracker to discuss both bugfixes and development of new features.

The 'good for new contributors' label is used for issues the development team thinks are a good place to begin working on Weston. These issues cover features or bugfixes which are small, self-contained, don't require much specific background knowledge, and aren't blocked by more complex work.

If you have picked an issue you would like to work on, you may want to mention in the issue tracker that you would like to pick it up. You can also discuss it with the developers in the issue tracker, or on the mailing list. Many developers also use IRC through OFTC's #wayland channel; however you may need to wait some time for a response on IRC, which requires keeping your client connected. If you cannot stay for a long time (potentially some hours due to timezone differences), then you may want to send your question to the list or issue tracker instead.

Sending patches

Patches should be sent via GitLab merge requests. Weston is hosted on freedesktop.org's GitLab: in order to submit code, you should create an account on this GitLab instance, fork the core Weston repository, push your changes to a branch in your new repository, and then submit these patches for review through a merge request.

Weston formerly accepted patches via git-send-email, sent to wayland-devel@lists.freedesktop.org; these were tracked using Patchwork. New email patches are no longer accepted.

Formatting and separating commits

Unlike many projects using GitHub and GitLab, Weston has a linear, 'recipe' style history. This means that every commit should be small, digestible, stand-alone, and functional. Rather than a purely chronological commit history like this: