mxsm/rocketmq-rust

[Docđź“ť] Improve rocketmq-namesrv resource config examples

Fermée

#7 622 ouverte le 28 juin 2026

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (1 personne assignée)Rust (245 forks)github user discovery
Difficulty level/Easydocumentationđź“ťgood first issuerocketmq-namesrv crate

Métriques du dépôt

Stars
 (1 484 étoiles)
MĂ©triques de merge PR
 (Métriques PR en attente)

Description

Issue Type

Improvement suggestion

Location

Files: rocketmq-namesrv/README.md, rocketmq-namesrv/README-zh_cn.md, rocketmq-namesrv/resource/namesrv.toml, rocketmq-namesrv/resource/namesrv-example.toml

Description

The README points users to the annotated example config, while resource/namesrv.toml currently contains only a placeholder rocketmqHome=11111. This can confuse first-time users who expect both files to be usable examples.

Suggested Fix

  • Clarify the difference between the minimal config and the fully annotated example config.
  • Replace the placeholder value in resource/namesrv.toml with a documented minimal example or clearly mark the file as a placeholder.
  • Keep English and Chinese README guidance aligned.
  • Check that the Quick Start commands still point to the intended config file.

Willing to contribute?

  • I can submit a PR for this

Guide contributeur

Direction de recherche
Clarifiez la difference entre la configuration minimale et l'exemple de configuration annote, remplacez la valeur factice dans namesrv.toml par un exemple minimal, alignez les directives du README en anglais et en chinois, et assurez vous que les commandes de demarrage rapide pointent vers le fichier de configuration prevu.
Stack technique
rust
Domaine
backenddatabase
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90