mxsm/rocketmq-rust

[Doc📝] Improve rocketmq-namesrv resource config examples

Fechada

#7.622 aberto em 28 de jun. de 2026

Ver no GitHubGuia do colaborador
 (3 comentários) (0 reação) (1 responsável)Rust (245 forks)github user discovery
Difficulty level/Easydocumentation📝good first issuerocketmq-namesrv crate

Métricas do repositório

Stars
 (1.484 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Esclareça a diferença entre o arquivo de configuração mínimo e o arquivo de exemplo anotado, substitua o valor de placeholder em namesrv.toml por um exemplo mínimo, alinhe a orientação do README em inglês e chinês e verifique se os comandos de início rápido apontam para o arquivo de configuração correto.
Pilha de tecnologia
rust
Domain
backenddatabase
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90