mapillary / mapillary/mapillary-python-sdk

[Good First Issue] List required of functions to create tests for

Open
#103 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
66
Forks
23
Avg merge
1d 20h
Merged PRs (30d)
11

Description

Currently, the tests/ directory does not test against every other function to give expected results.

The work towards testing should be done in these phases,

  1. List functions that need to have unit tests created
  2. Create a mechanism to fetch GeoJSONs from the API that are guaranteed the right results to test against
  3. Assert the functionality is working as expected with the fetched data

Help is required with the 1st step. Having a list of unit tests to implement would be great - not everything can be tested.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing tests/ directory and the Python package functions it covers. Compare that coverage with the available Mapillary API and GeoJSON-related functionality. Done means producing a documented list of worthwhile unit tests for phase 1; fetching API data and adding assertions are later phases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, testing
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.