Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (28 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

48 lines (28 loc) · 1.51 KB

Contributing

We welcome all contributions, bug reports, and suggestions!

Installing the development version

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

  • Clone this repository using git clone.
$ git clone https://github.com/koordinates/koordinates-qgis-plugin.git
  • Move to the koordinates-qgis-plugin folder and run the helper install task by running
$ python helper.py install

That will create a symlink between the repository folder and the QGIS 3 plugins folder.

  • 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, run the helper package task by running

$ python helper.py install

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

CI

Continuous integration builds an install package for every commit. Artifacts are published to Github Actions.

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.