Skip to content

docs: align project docs and console-web pre-commit#100

Merged
GatewayJ merged 1 commit intorustfs:mainfrom
GatewayJ:main
Mar 28, 2026
Merged

docs: align project docs and console-web pre-commit#100
GatewayJ merged 1 commit intorustfs:mainfrom
GatewayJ:main

Conversation

@GatewayJ
Copy link
Copy Markdown
Member

Type of Change

  • New Feature
  • Bug Fix
  • Documentation
  • Performance Improvement
  • Test/CI
  • Refactor
  • Other:

Related Issues

N/A

Summary of Changes

This PR aligns contributor and architecture documentation with the current codebase and development workflow, and standardizes English across READMEs and shell scripts.

  • Docs: Update CLAUDE.md, ROADMAP.md, CONTRIBUTING.md, docs/DEVELOPMENT.md, docs/DEVELOPMENT-NOTES.md, .github/AGENTS.md; clarify CI vs local make pre-commit, service ports (S3 9000, RustFS Console 9001, Operator HTTP console 9090), and reconcile/status roadmap items.
  • src/console/: Translate Rust doc comments and line comments to English only (no behavior change).
  • Scripts / examples: English messages and comments; port and credential notes in examples.
  • console-web / Makefile: Fix npm run lint to use eslint .; add format / format:check npm scripts; Makefile console-fmt targets call them so make pre-commit works after npm install in console-web/.
  • CHANGELOG: Document the above under [Unreleased].

Checklist

  • I have read and followed the CONTRIBUTING.md guidelines
  • Passed make pre-commit (fmt-check + clippy + test + console-lint + console-fmt-check)
  • Added/updated necessary tests (N/A: documentation and comment-only changes; Rust tests unchanged)
  • Documentation updated (if needed)
  • CHANGELOG.md updated under [Unreleased] (if user-visible change)
  • CI/CD passed (if applicable)

Impact

  • Breaking change (CRD/API compatibility)
  • Requires doc/config/deployment update
  • Other impact: None for runtime behavior; contributors should run npm install in console-web/ before make pre-commit.

Verification

make pre-commit

Additional Notes

N/A


Thank you for your contribution! Please ensure your PR follows the community standards (CODE_OF_CONDUCT.md) and sign the CLA if this is your first contribution.

Clarify CI vs make pre-commit, service ports, and roadmap status. Standardize scripts and READMEs to English. Translate console module comments to English (no behavior change). Fix console-web lint (eslint .) and Prettier targets via npm scripts and Makefile.

Made-with: Cursor
@GatewayJ GatewayJ added this pull request to the merge queue Mar 28, 2026
Merged via the queue into rustfs:main with commit 42f2102 Mar 28, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant