adorsys / adorsys/status-list-server
Add idiomatic CONTRIBUTING.md for Rust server contributors
- Linguagem predominante
- Rust
- Estrelas
- 22
- Forks
- 5
- Merge médio
- 2d 6h
- PRs com merge (30d)
- 47
Descrição
## Objective
Purify and humanize `CONTRIBUTING.md` and related contributor documentation so it reads naturally, eliminates AI boilerplate, and accurately reflects the exact current tooling, development scripts, architecture, and CI workflow of the project.
## Context
Contributor documentation should feel natural, practical, and welcoming. Boilerplate jargon, inflated claims, and stale instructions increase contributor friction. The guide needs to be a concise, direct, human-written reference tailored specifically to how this Rust server is built, tested, linted, and reviewed today.
## Deliverables
- [ ] **Human-centered rewrite:** Rewrite `CONTRIBUTING.md` using clear, pragmatic, human-written phrasing free of AI filler words, corporate jargon, and generic boilerplate.
- [ ] **Toolchain & Setup:** Provide direct, accurate setup instructions for the Rust toolchain (Rust edition 2024 / MSRV), cargo tools (`cargo-nextest`, `cargo-deny`, `cargo-audit`), and optional container services.
- [ ] **Day-to-day workflow commands:** Document the exact commands used locally that mirror GitHub CI:
- Unit & integration tests: `cargo nextest run --all-features`
- Linting & formatting: `cargo fmt --check`, `cargo clippy --all-targets --all-features -- -D warnings`
- Local CI harness: `bash scripts/local-ci.sh`
- [ ] **Architecture guidelines:** Briefly explain how to extend the server following the ports and adapters architecture without touching core domain types unless required.
- [ ] **PR & Git standards:** Detail Conventional Commits formatting, atomic PR expectations, test coverage expectations, and documentation updates.
- [ ] **Clean links:** Provide accurate links to relevant documents.
## Acceptance Criteria
- [ ] `CONTRIBUTING.md` reads naturally and is straightforward for both new and experienced Rust contributors.
- [ ] All listed commands and workflow steps match the actual scripts and CI definitions in `.github/workflows/`.
- [ ] Passes markdownlint validation cleanly.
## Verification
- [ ] `markdownlint-cli2 "**/*.md"`
- [ ] Review tone and structure against human writing guidelines
- [ ] Smoke-test listed contributor commands in a fresh checkout
Guia de contribuição
Direção de pesquisa
Open `CONTRIBUTING.md` first and treat it as the primary file to rewrite. Next, compare the listed workflows and commands with `.github/workflows/` and `scripts/local-ci.sh` to align the instructions with reality. Run `markdownlint-cli2 "**/*.md"` and the smoke-test commands in the issue body (`cargo nextest run --all-features`, `cargo fmt --check`, `cargo clippy --all-targets --all-features -- -D warnings`, `bash scripts/local-ci.sh`); done means docs are natural, accurate, and validated.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- github-actions, rust
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Pouca atividade
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 68/100