share / share/sharedb

Clean up doc "op" and "batch op" event arguments

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

Nobody has claimed this yet.

breaking-change
Dominant language
JavaScript
Stars
6.5k
Forks
456
Avg merge
1d 5h
Merged PRs (30d)
5

Description

To consider for a future 2.0 release:

  • Consolidate source and op.src event args into an object with named fields
  • Rename source to isOwnOp
  • Maybe change event names to "op component" and "op"?

https://github.com/share/sharedb/pull/401/files#diff-052d027bfe6809ffc3ec4f047c9cef649199cf90c9ac1bb9c8d6a8149774645fR637-R638

Contributor guide

No contributing guide indexed for this repository

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 with the event-argument code referenced in the linked pull request and trace the current source, op.src, and event-name usages. Clarify the intended 2.0 API changes before editing; the work is done when the argument shape, naming, and event names are consistently updated and their affected usages are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend
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.