Commit Graph

15 Commits

Author SHA1 Message Date
安正超 3dbcaaa221 docs: simplify crates README files and enforce PR-only workflow (#110)
* docs: simplify all crates README files

- Remove extensive code examples and detailed documentation
- Convert to minimal module introductions with core feature lists
- Direct users to main RustFS repository for comprehensive docs
- Updated 20 crate README files for consistency and brevity

Files updated:
- crates/rio/README.md (415→15 lines)
- crates/s3select-api/README.md (592→15 lines)
- crates/s3select-query/README.md (658→15 lines)
- crates/signer/README.md (407→15 lines)
- crates/utils/README.md (395→15 lines)
- crates/workers/README.md (463→15 lines)
- crates/zip/README.md (408→15 lines)

* docs: restore original headers in crates README files

- Add back RustFS logo image and CI badges
- Restore formatted headers and structured layout
- Keep simplified content with module introductions
- Maintain consistent documentation structure across all crates

All 20 crate README files now have proper headers while keeping
the simplified content that directs users to the main repository.

* rules: enforce PR-only workflow for main branch

- Strengthen rule that ALL changes must go through pull requests
- Explicitly forbid direct commits to main branch under any circumstances
- Add comprehensive PR requirements and enforcement guidelines
- Clarify that PRs are the ONLY way to merge to main branch
- Add requirement for PR approval before merging
- Include enforcement mechanisms for branch protection
2025-07-08 21:10:07 +08:00
overtrue efae4f5203 wip 2025-06-17 22:37:38 +08:00
weisd 711cab777f docs: update error handling guidelines to thiserror pattern 2025-06-09 15:35:01 +08:00
overtrue 8747a91df8 feat: add comprehensive formatting rules and type inference guidelines 2025-05-28 16:04:38 +08:00
安正超 6350398c31 docs: add critical rule to never commit directly to master branch 2025-05-28 12:01:46 +08:00
安正超 a1f4abf6c3 fix: resolve all Clippy warnings across codebase - Fixed field reassignment warnings in ecstore/src/file_meta.rs by using struct initialization instead of default + field assignment - Fixed overly complex boolean expression in ecstore/src/utils/os/mod.rs by removing meaningless assertion - Replaced manual Default implementation with derive in crates/zip/src/lib.rs - Updated io::Error usage to use io::Error::other() instead of deprecated pattern - Removed useless assertions and clone-on-copy warnings - Fixed unwrap usage by replacing with expect() providing meaningful error messages - Fixed useless vec usage by using array repeat instead - All code now passes comprehensive Clippy check with --all-targets --all-features -- -D warnings 2025-05-28 11:00:07 +08:00
overtrue cae578d6b5 docs: add commit message length and PR format rules 2025-05-25 13:59:22 +08:00
overtrue 42b38336ad docs: add cross-platform CPU architecture compatibility guidelines 2025-05-25 13:57:06 +08:00
overtrue ad71db6367 docs: add requirement for English PR descriptions in development workflow 2025-05-25 13:55:51 +08:00
overtrue e838f4292c docs: add strict branch management rules to prevent direct main branch modifications 2025-05-25 13:43:24 +08:00
overtrue d7b3e20233 docs: enhance cursor rules with code quality standards 2025-05-25 13:34:06 +08:00
overtrue c970ed1587 docs: translate .cursorrules from Chinese to English 2025-05-25 13:32:33 +08:00
overtrue d9d889cb4f feat: add comprehensive tests for event-notifier error module 2025-05-25 13:28:16 +08:00
overtrue 9604efd5cc feat: add comprehensive tests for event-notifier error module 2025-05-25 13:26:25 +08:00
overtrue a6c3b122bd feat: enhance test coverage and fix compilation errors 2025-05-25 12:56:43 +08:00