Welcome to the contributors' guide on the ArcGIS Maps SDK for Qt Toolkit! We hope this document encourages you to help improve and expand upon our toolkit offering.
For specific resources on:
You will need:
- System requirements as laid out here for your development platform.
- Latest version of the ArcGIS Maps SDK for Qt.
-
The ArcGIS Maps SDK for Qt Reference. Which includes:
-
DSA App, an open source project built with the ArcGIS Maps SDK for Qt Toolkit.
There are two active branches within toolkit: main and v.next.
-
main is the active branch, and must always be compatible with the release version of ArcGIS Maps SDK for Qt. This is the main branch all our users consume to access toolkit features.
-
v.next is the "next version" branch which contains upcoming features and is compatible with the upcoming version of the ArcGIS Maps SDK. While anyone may contribute to this branch, public contributors outside of Esri will not be able to build this branch as the upcoming version of ArcGIS Maps SDK will be unavailable.
If you are contributing a bugfix, and you believe the bug is high priority in impact, then target the main branch in your PR. Otherwise consider targeting v.next! If unsure, the PR reviewer can help make the right call.
Once you have implemented a new feature, and are ready for a pull-request, please target the v.next branch. This helps the toolkit team verify the feature is production ready before we ship!
Please always document your update in CHANGELOG.md.
If you are a public contributor from outside Esri, ask ldanzinger (product owner), for a review! He will review/assign an appropriate developer to look into your contribution.
Report all bugfixes/enhancements to https://github.com/Esri/arcgis-runtime-toolkit-qt/issues. Be clear in your reproduction steps and use your best judgement for communicating your problem.
We do not enforce that public contributors add to the testing suite, but we encourage it. If submitting a new feature, please consider adding an example to one of the example apps.
Resources can be found as follows:
-
Functional/unit tests can be found in tests.
-
Augmented reality examples can be found in augmented_reality/Examples.
-
UI tool examples can be found in uitools/examples.
-
The Calcite QML style demo can be found in calcite-qml/demo.
Often, users ask questions on Esri Community! The ArcGIS Qt team are very good at answering questions in a timely manner, and it is a fantastic repository of past questions.
We are happy to take public contributions to the toolkit. At the end of each release we will update our
contributors section of the main README.md with
the accounts of everyone who has made a contribution to the toolkit.
TBD.
For QML code, please follow the official QML coding conventions.
For C++, please run clang-format before submitting your PR. clang-format should automatically pick up the .clang-format
file found here.
(Take a look at this Qt blog post on enabling clang-format to run in Qt creator.)