alibaba/nacos

[Nacos 3.0] Enhance usage material for distributed locks.

Open

#12,954 opened on Dec 17, 2024

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Java (32,948 stars) (13,279 forks)batch import
help wantedkind/featureversion/3.x

Description

In GLCC 2023, Nacos community has finished the basic usage for distributed locks and plan to add this feature into nacos 3.0 version.

During one year development, the default branch and 3.0 branch include many changes and growing, the feature branch of distributed locks has many below and conflicts with 3.0 branch.

So community hope someone help to solve these conflicts first and add whole tests (unit test or integration test) for distributed locks feature.

Finally, community also hope someone can help to fill more usage document about distributed locks feature in nacos, which make users can use the feature well.

So sub tasks following:

  • solve conflicts for brach summer-glcc#10378 with 3.0 develop branch and make sure feature can be used well.
  • Add more complete tests such as unit test or integration test to ensure the feature.
  • Add usage document includes usage document and description document.

Contributor guide

Tech stack
java
Domain
backenddatabase
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
Java programmingDistributed systems conceptsNacos frameworkUnit testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review the existing branch 'summer glcc#10378' to understand the distributed locks feature. Look at current unit and integration tests in the Nacos repository (likely under tests directories). Identify where tests should be added. Also examine any existing documentation for distributed locks. Check comment threads for guidance. See if there are any open PRs related to distributed locks.