mapbox / mapbox/robosat

Refactor top level robosat module

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

Nobody has claimed this yet.

Dominant language
Python
Stars
2.1k
Forks
385
PR merge metrics
No merged PRs in 30d

Description

We still have a lot of code in the top level module from a time before we had sub-modules:

https://github.com/mapbox/robosat/tree/52299b855b77225b795b015944e31cbddb9ce44b/robosat

We should refactor the code here, e.g. putting the modelling code into a `robosat.model` sub-module.

Tasks:
- [ ] Refactor top-level robosat directory into sub-modules

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 top-level robosat directory at the referenced commit and inventory the code that remains there. Identify cohesive sub-modules, including the proposed robosat.model module, and confirm that the refactored structure preserves existing behavior. Done means the top-level directory has been organized into appropriate sub-modules.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
machine-learning
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.