Skip to content

docs: update readme - #494

Merged
gufengc merged 2 commits into
mainfrom
readme
Jun 26, 2026
Merged

gufengc merged 2 commits into
mainfrom
readme

Conversation

@gufengc

@gufengc gufengc commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

📋 PR Title Format

The PR title should follow the format:

type(scope): concise message (max 50 chars)

Where:

  • type is one of: feat, fix, docs, refactor, perf, test, chore.
  • scope is optional and describes the part of the codebase affected (e.g., auth, ui, api).
  • concise message is a short description of the change (max 50 chars).

📝 Change Type

Please select the type of change this PR introduces (choose one or more):

  • feat: New feature.
  • fix: Bug fix.
  • docs: Documentation only changes.
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • perf: Performance improvement.
  • test: Adding missing tests or correcting existing tests.
  • chore: Maintenance tasks (e.g., updating dependencies).

💡 Description

Briefly describe the change, its purpose, and the problem it solves.

Key Changes

🔗 Related Issues

List any issues this PR closes or relates to:

  • Closes #IssueNumber (e.g., Closes #123)

✅ Checklist

Please ensure the following points are addressed before merging:

  • I have performed a self-review of my own code.
  • I have added/updated tests that prove my fix or feature works (if applicable).
  • I have updated the documentation (if necessary).
  • My code follows the project's style guidelines.

@gufengc
gufengc requested a review from a team June 26, 2026 06:55
@gufengc
gufengc merged commit 5aad2e6 into main Jun 26, 2026
5 checks passed
@gufengc
gufengc deleted the readme branch June 26, 2026 07:09
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