Skip to content

Latest commit

 

History

History
88 lines (56 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

88 lines (56 loc) · 2.65 KB
Raw

Contributing

If you are interested in contributing to the Library/demos, please head over to https://github.com/workbenchdev/demos instead.

Either way, don't hesitate to get in touch.

Getting started

The following is the recommended setup:

  1. Install GNOME Builder from Flathub
  2. Open Builder and select "Clone Repository..."
  3. Clone https://github.com/workbenchdev/Workbench.git (or your fork)
  4. Press the Run ▶ button

Make sure that you're building the development target re.sonny.Workbench.Devel.

If you know what you are doing you can also use VSCode with the extensions recommended in this workspace or anything else you are comfortable with. Don't forget to fetch the submodules.

Setup

We provide a couple of tools to make the development process pleasant.

  • Code formatter that runs automatically on git commit
  • Single command to run all the tests locally
# Ubuntu requirements
# sudo apt install flatpak flatpak-builder nodejs make gcc g++

# Fedora requirements
# sudo dnf install flatpak flatpak-builder nodejs make gcc gcc-c++

cd Workbench
make setup

Before submitting a PR, we recommend running tests locally with

make test

Submitting a contribution

  • Unless you don't want too - add your name to the list of contributors
  • Open a pull request
  • Make sure to review your own changes
  • Commits are squashed into a single commit on merge

Debugging

To view debug logs, use the following command in src/workbench.

--command "G_MESSAGES_DEBUG=\"@app_id@\" @app_id@ $@"

See also

Translation

Workbench doesn't currently support translations for its user interface. GNOME documentation is only available in English and we do not want to mislead non-English speakers.

Troubleshooting

The app won't build/run anymore - even on clean main

Clean the build directory. On GNOME Builder, open the search palette with Ctrl+Enter and search/select Clean.

If that doesn't solve it - remove the GNOME Builder cache directory

rm -r ~/.var/app/org.gnome.Builder/cache/