pelias / pelias/api

Move localNamingConventions logic to pelias/labels

Open
#1,293 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
JavaScript
Stars
259
Forks
168
Avg merge
6h 15m
Merged PRs (30d)
1

Description

We have, for a very long time, had a little bit of logic for managing one small aspect of localization (the order of housenumber and street name in labels) in a file in pelias/api: middleware/localNamingConventions.js.

Since that file was created, we've created an entire package, pelias/labels, for managing the complexities of generating labels that are accurate for different parts of the world.

We should probably get around to moving this logic into pelias/labels someday.

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 reading middleware/localNamingConventions.js and the pelias/labels package to understand the existing localization logic and its intended destination. Confirm that the house-number and street-name ordering behavior remains unchanged, with the logic moved out of pelias/api and maintained by pelias/labels.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
localization
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.