Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

67 lines (51 loc) · 2.45 KB
Raw

Contributing

Code

Be sure to follow the code style of the project.

Adding a feature

Create an issue or join the Discord/Matrix to discuss it with the maintainers. We will provide additional guidance.

Fixing a bug

Fork the repository, make your changes, then create a pull request. Be sure to mention the GitHub issue you're fixing if one was already open.

Translations

Weblate

The project can be translated on Weblate.

Manually

  1. Clone the repository.
  2. If it isn't already there, add your language to /po/LINGUAS.
  3. Create a new translation from the /po/cartridges.pot file with a translation editor such as Poedit.
  4. Save the file as [YOUR LANGUAGE CODE].po to /po/.
  5. Create a pull request with your translations.

Building

GNOME Builder

  1. Install GNOME Builder.
  2. Click "Clone Repository" with https://github.com/kra-mo/cartridges.git as the URL.
  3. Click on the build button (hammer) at the top.

For Windows

  1. Install MSYS2.
  2. From the MSYS2 shell, install the required dependencies listed here.
  3. Build it via Meson.

For macOS

  1. Install Homebrew.
  2. Using brew and pip3, install the required dependencies listed here.
  3. Build it via Meson.

Meson

git clone https://github.com/kra-mo/cartridges.git
cd cartridges
meson setup build
ninja -C build install

Code style

All code is auto-formatted with Black and linted with Pylint. Imports are sorted by isort.

VSCode extensions are available for all of these and you can set them up with the following settings.json configuration:

"python.formatting.provider": "none",
"[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
        "source.organizeImports": true
    },
},
"isort.args":["--profile", "black"],

For other code editors, you can install them via pip and invoke them from the command line.