mozilla/mentat

[doc] Simplify the upsert resolution Wiki page to agree with the actual implementation

Open

#313 opened on Feb 15, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (116 forks)github user discovery
A-transactdocumentationhelp wantedhygieneready

Repository metrics

Stars
 (1,661 stars)
PR merge metrics
 (PR metrics pending)

Description

Now that #283 has landed, the documentation at https://github.com/mozilla/mentat/wiki/Transacting:-upsert-resolution-algorithm is stale. Luckily, it's stale 'cuz the implementation is simpler than the algorithm description! This ticket is a marker for us to loop back to the Wiki and make sure what we actually do in the Rust implementation is accurately described in the Wiki.

See also #207, which might be addressed concurrently.

Contributor guide

Research direction
Read the current Wiki page, review the implementation in pull request #283, and update the Wiki to reflect the simpler algorithm.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitWiki editing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90