sidorares/node-mysql2

Documentation for Binary Log Protocol Client

Open

#688 opened on Nov 23, 2017

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)TypeScript (677 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (4,383 stars)
PR merge metrics
 (Avg merge 18h 50m) (29 merged PRs in 30d)

Description

There currently seems to be no documentation of the Binary Log Protocol Client feature...

I'm not there yet, but I will need to know about this feature.

When I do get there, I'll start posting comments here with what I find out.

Please, anyone in the same situation do the same.

At some point these details can be collected and a PR submitted to update documentation.

Contributor guide

Research direction
Explore the source code for the Binary Log Protocol Client and document its configuration, usage, and behavior. Look for test files or examples that demonstrate the feature.
Tech stack
typescriptnodejssql
Domain
backenddatabase
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
GitMySQL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70