hackmdio/codimd

Track changes mode

Open

#603 opened on Oct 27, 2017

View on GitHub
 (3 comments) (7 reactions) (0 assignees)JavaScript (1,038 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (8,949 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

First of all: I really love hackmd! It's a great tool and my organization uses it on a day to day basis!

We mainly use it as a fast and easy way to write down some structured ideas or to take minutes of meetings. For the review of minutes it would be awesome to have something like a tracking mode (cf. GoogleDocs, Word or other editors) where e.g. the initial author of a document can freeze its state and all changes have to be accepted by him afterwards.

Knowing about the revision view I hope it would be possible to include this additional feature and I hope it would be appreciated by others as well.

Contributor guide

Research direction
Study the existing revision view and document model in CodiMD. Understand how changes are stored and diffed. Propose a UI overlay that toggles a 'track changes' mode, highlighting insertions and deletions, and requiring acceptance. Investigate operational transformation (OT) or conflict free replicated data types (CRDT) for change tracking.
Tech stack
javascript
Domain
full stack
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScriptNode.jsCollaborative editing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35