mapbox / mapbox/osm-analysis-dashboard

Cleanup code

Open
#8 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
6
Forks
3
PR merge metrics
No merged PRs in 30d

Description

@tridip1931 creating a stub issue here to discuss and go ahead with some code-cleanups

Here's how I'm thinking about it:

- As a start, just organize the current file, make sure things are logically separated, and add comments
- Work with @kepta to setup `rollup` to have a module system we can use in this repository
- Separate out some things into separate modules / files, especially make sure all `constants` that should be configurable, like `filterProperties` for eg. are in a separate file.

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 current file and the existing repository structure to identify the code that needs logical separation. Discuss the proposed Rollup module system with @kepta and determine which constants, including filterProperties, should become configurable. Done means the cleanup plan and module boundaries are agreed and the code is organized accordingly.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, rollup
Domain
build-system, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.