CONTRIBUTING.md

Contributing to HERE Map Widget for Jupyter

Thank you for taking the time to contribute.

The following is a set of guidelines for contributing to this package. These are mostly guidelines, not rules. Use your best judgement and feel free to propose changes to this document in a pull request.

Coding Guidelines

1. Lint your code contributions as per pep8 guidelines.

To help you out, we have scripts in pyproject.toml which supports the commands below:

Autoformat code using black:

hatch run lint:reformat

Check for linting errors:

hatch run lint:check

Make sure hatch CLI is installed via an installer, pip, or conda beforehand.

2. Sort the imports in each python file as per pep8 guidelines

Please execute the isort utility to have the imports sorted auto-magically.

Notebooks

Example notebooks are provided in /examples.

Edit documentation

Source of documentaion is available in /docs.

Following commands build documentation

cd docs
make html

Rebuild

The following command allows you to delete final and intermediate artifacts from the project directory.

hatch run clean-all

It's possible to try dry-run before executing removal.

hatch run clean-all-dry

Signing each Commit

When you file a pull request, we ask that you sign off the Developer Certificate of Origin (DCO) in each commit. Any Pull Request with commits that are not signed off will be rejected by the DCO check.

A DCO is a lightweight way to confirm that a contributor wrote or otherwise has the right to submit code or documentation to a project. Simply add Signed-off-by as shown in the example below to indicate that you agree with the DCO.

The git flag -s can be used to sign a commit:

git commit -s -m 'README.md: Fix minor spelling mistake'

The result is a signed commit message:

README.md: Fix minor spelling mistake

Signed-off-by: John Doe <john.doe@example.com>