Skip to content

2.5 Release Checklist

Jump to bottom
Ben Clark edited this page Dec 19, 2024 · 3 revisions

Key:

  • 🐛 is for issues that we aren't planning on shipping and are known to not be working. Each of these should have an issue link associated.
  • ⚠️ is for a known bug that we still need to fix prior to getting this release out the door. Should also link out to issues created.
  • 🚢 is for an issue whose bug as been squashed. Ship it!

As we test, put a ❌ next to stuff that is buggy/needs fixing before release.

Release tasks

  • Bump version to whatever is appropriate
  • Update CHANGELOG to contain latest on bugfixes, improvements, etc.
  • Update Splash screen to cover latest happenings
  • Create a new social posts with the latest on the changes, etc.
  • Write internal post about the release and what's in it
  • Check in the latest artifacts to dist/

Test Suite passes

  • Fix any/all issues with 'npm test' that have crept in since our last release.

Bundle size

Inspect and compare bundle sizes and ensure:

  • No imports are double-included
  • No bundled dependencies are unexpectedly large

Bugs found:

Release-specific testing for new features

  • Unified Data Catalog
  • Right-click menu for MapRoulette
    • All four options work
  • webGPU url param works (already QA'd / heavily tire-kicked by the community)
  • Footways testing (already QA'd)
  • Kerb node validation (already QA'd)
  • New keyboard shortcuts work (streetview imagery)
    • Shift+M Toggles mapillary layer
    • Shift+S Toggles Bing Streetside layer
    • Shift+K Toggles KartaView layer

🐛 Looks like the menu doesn't dynamically check these boxes when the shortcut is hit. It unchecks when turned off though.

Browsing:

Navigation

  • Arrow keys pan the map ↓, ↑, ←, →
  • ⌥ + Arrow keys pan the map more
  • + and - keys zoom in and out
  • ⌥ - and ⌥ + zoom the map more

Geocoding

  • Type a placename into the search bar, hit 'Search Entire World', see a list of items
  • Click on a member of that list to automatically zoom/pan to the entity in question

Display Options

  • B Toggles the imagery pane
  • ⌘+B switches to last background
  • , switches to previous background in list
  • . switches to next background in list
  • F toggles the map data pane
  • I toggles the validation issues pane
  • P Toggles the user preferences pane
  • ⌃Ctrl + ⌘Cmd + F or F11 switch to full screen mode
  • ` key or shift+2 toggles the sidebar :
  • W toggles wireframe mode
  • Shift + O toggles OSM data on/off
  • / toggles the minimap on/off :bug: minimap seems to be too zoomed in
  • ⌘Cmd+/ toggles the 3d map on/off
  • 3D Map allows right-click to adjust viewing angle and spin around the center point
  • mousing off the 3D map causes it to stick to its current spin-orientation
  • clicking 'reset bearing' control resets the bearing to true north.
  • g highlights unsaved edits #509
  • Shift + R Toggles rapid features on/off

Help

  • H toggles help
  • ? toggles keyboard shortcuts

Selecting Features

  • l-click, tap, or space selects a feature
  • shift + l-click selects multiple
  • shift+ l-click + drag draws a lasso selection around features
  • ⌘ F finds features matching search text

With features selected

  • Right-click or long press or menu button (space bar) toggles the edit menu 🐛 Menu Button (Space bar) doesn't toggle edit menu?
  • Z zooms to the selected features

With node selected

  • [ or ↖ PgUp jump to previous node
  • ] or ↘ PgDown jump to next node
  • { or ⇞ Home jump to first node
  • } or ⇟ End jump to last node
  • ⌘ ↑ selects parent way
  • (on a node with multiple parent ways) \ or Pause switches parent way 🐛 Looks like the \ key still works in v1, not v2

With Way Selected

  • ⌘ ↓ selects child nodes

Editing

Drawing

  • 1 Add Point mode

  • 2 Add Line mode

  • 3 Add Area mode

  • N Add Note mode (when enabled) 🐛 should change icon to crosshairs when placing a new note, not the grabby-hand

  • l-click, tap, or Spacebar should add a point or note while in this mode

  • ⌥ Option holding should disable point snapping

  • ↵Return or ⎋Esc should finish drawing a line or area

Commands

  • ⌘ Cmd + C copies selected feature
  • ⌘ Cmd + V pastes selected feature
  • ⌘ Cmd + Z Undoes last edit
  • ⌘ Cmd + ⇧ Shift + Z Redoes last edit
  • ⌘ Cmd + S saves changes to OSM

RapiD AI-Assist

  • A adds the selected rapid feature
  • D ignores the selected feature

Operations

  • A continues a line at the selected endpoint
  • C combines (merges) selected features
  • D disconnects the selected features
  • E extracts a point from a feature (as long as the node is 'interesting', otherwise this won't show up as an option)
  • X splits features at the selected points
  • v reverses the selected features
  • m moves the selected features
  • ⇧Shift + ↓, ↑, ←, → nudge the feature by a small amount
  • 🐛 Looks like this only works for up and down, not side-to-side. Regression from map rotation?
  • ⌥Option ⇧Shift + ↓, ↑, ←, → nudge the feature by a lot #525
  • ⇧Shift + + or - scales the feature #912
  • ⌥Option⇧Shift + + or - scales the feature #912
  • R rotates the selected features
  • Q squares the corners of a line or area
  • S straightens the line or group of points
  • O circularizes a closed line or area
  • T flips features across the long axis
  • Y flips features across the shorter axis
  • ⌘Cmd + ⌫Delete deletes the selected feature
  • ⇧Shift + C cycles the road tag preset for a way

Tools

Information

  • ⌘Cmd + I Toggles all information panels
  • ⌘Cmd + ⇧Shift + B Toggles Background panel
    • New in 2.3: ESRI Wayback imagery shows vintage when it's enabled
  • ⌘Cmd + ⇧Shift + H Toggles History panel
  • ⌘Cmd + ⇧Shift + L Toggles Location panel
  • ⌘Cmd + ⇧Shift + M Toggles Measurement panel

Drawing

Points

  • Clicking an empty map area creates a new node.
  • option-Clicking on an existing vertex creates a new node.
  • After node creation, the 'tag this feature' dialog appears in the sidebar, prompting the user to classify the feature.
  • Directional points show their facing with viewfield cones
  • Undo/redo works as expected

Ways

All new nodes

  • Creating a new way works by just mouse clicking from point to point, ending by clicking the same point twice.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Same, but with clicking the FIRST point to close the way.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Hitting ESC can end the draw mode.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • History undo/redo during the draw operation looks good and does not have 'extra' states in it.

Combination of new / existing vertices / points

  • Creating a new way works by just mouse clicking from point to point, ending by clicking the same point twice.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Same, but with clicking the FIRST point to close the way.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Hitting ESC can end the draw mode.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • History undo/redo during the draw operation looks good and does not have 'extra' states in it.

New way from ONLY existing vertices / points

  • Creating a new way works by just mouse clicking from point to point, ending by clicking the same point twice.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Same, but with clicking the FIRST point to close the way.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Hitting ESC can end the draw mode.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • History undo/redo during the draw operation looks good and does not have 'extra' states in it.

Areas

All new nodes

  • Creating a new area works by just mouse clicking from point to point, ending by clicking the first point twice.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Hitting ESC can end the draw mode, auto-closing the area.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • History undo/redo during the draw operation looks good and does not have 'extra' states in it.

Combination of new / existing vertices / points

  • Creating a new area works by just mouse clicking from point to point, ending by clicking the first point twice.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • History undo/redo during the draw operation looks good and does not have 'extra' states in it.

  • Same as previous creation test, but instead of clicking on the first node, hit ESC to end the draw mode.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • History undo/redo during the draw operation looks good and does not have 'extra' states in it.

New area from ONLY existing vertices / points

  • Creating a new area works by just mouse clicking from point to point, ending by clicking the same point twice.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Same, but with clicking the FIRST point to close the area.

  • History undo/redo for previous looks good and does not have 'extra' states in it.

  • Hitting ESC can end the draw mode.

  • History undo/redo after finishing the draw operation looks good and does not have 'extra' states in it.

  • History undo/redo during the draw operation looks good and does not have 'extra' states in it.

Walkthrough

Get through all steps without help

  • Welcome
  • Navigation
  • Points
  • Areas
  • Ways
  • Buildings
  • Rapid
  • Finish

Clone this wiki locally