Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 1.54 KB
Raw

Contributing

We welcome all contributions, bug reports, and suggestions!

Installing the development version

To install the latest version from this repository, follow these steps:

  • Install Kart
  • Clone this repository using git clone.
$ git clone https://github.com/koordinates/kart-qgis-plugin.git
  • Create a link between the repository folder and the QGIS 3 plugins folder.
$ cd kart-qgis-plugin
$ python helper.py install
  • Start QGIS and you will find the plugin in the plugins menu. If it's not available yet, activate it in the QGIS Plugin Manager.

Packaging

To package the plugin, suitable for installing into QGIS:

$ python helper.py package

A kart.zip file is generated in the repo root.

CI

Continuous integration builds an plugin package for every commit, artifacts are available to download.

Code formatting

We use Black to ensure consistent code formatting. We recommend integrating black with your editor:

We use the default settings, and target python 3.7+.

One easy solution is to install pre-commit, run pre-commit install --install-hooks and it'll automatically validate your changes code as a git pre-commit hook.