sidorares / sidorares/node-mysql2

Documentation for Binary Log Protocol Client

Open
#688 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
TypeScript
Stars
4.4k
Forks
680
Avg merge
9h 7m
Merged PRs (30d)
59

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

Open the contributing guide

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 by locating the Binary Log Protocol Client feature and reviewing any existing project documentation about it. Identify the details users need to understand and collect them into a documentation update; done means the feature is documented clearly enough for someone who needs to use it.

Written by the indexing model from the issue text.

Assessment

Tech stack
mysql, node.js, typescript
Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.