Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

45 lines (37 loc) · 3.65 KB
Raw

Contributing to the SaveDesktop app

First, thanks for your interest in the contribution to this app, I appreciate it!

There are a couple of ways to contribute to this app:

Translations

Thanks to the community, SaveDesktop is translated into more than 20 languages. However, if your language is not available in the app or if your language in the app is not complete, feel free to add or edit it using Weblate! To add or modify an existing language, you must be registered for Weblate, which can be done via email, a Github or Google account, and many other services.

Involvement in development

The SaveDesktop application is written in Python 3 using GTK 4.0 and LibAdwaita libraries, so if you have knowledge of Python and, ideally, in combination with these libraries, your contributions are welcome! If you don't know how to contribute specifically, you can check out the issues marked as “good first issue”.

No Python knowledge? Never mind. For example, you can contribute to improving the webpage of this application, the source code of which can be found in the webpage branch of this repository, or improving the documentation of this app.

So how to proceed?

  1. Fork this repository (see the Github docs for more information)
  2. Go to your fork of this repository (e.g., https://github.com/<your_username>/SaveDesktop)
  3. Go to the src source folder and make the changes you want.
    • If you have decided to edit the source code of the webpage, go to the webpage branch of your fork of this repository and make the changes you want.
  4. If you want to test your changes, you can proceed as follows:
    • clone your fork 
      git clone https://github.com/<your_username>/SaveDesktop
    • go to the cloned fork folder 
      cd SaveDesktop
    • build the application using Flatpak Builder
      • if you have not installed org.gnome.Sdk (version 46) runtime, install it using this command: flatpak install runtime/org.gnome.Sdk/x86_64/46 -y
      flatpak-builder build *.yaml --install --user
      • alternatively, you can build a native version as follows (assuming you have GTK 4.0 and LibAdwaita libraries in the latest version): 
        sh native/install_native.sh --install
  5. Once you are happy with your changes, submit a pull request to this repository, which I will review and merge with my repository if necessary.

It should be noted that this app is available under the GNU GPL 3.0 license, so it is necessary to follow the license conditions.

Reporting issues

Have you found a bug in the app? Do you have a suggestion for a new feature, or is something not clear? You can use Github issues for this purpose, but make sure someone else hasn't reported a similar issue before you. Don't prefer Github issues? If so, you can use this form or Github discussions.

I look forward to your contributions to this app!