docs: update README and add contributing guide

2025-06-03 23:23:24 +08:00
parent ee48c2f09d
commit 3c9a622a18
7 changed files with 83 additions and 83 deletions
@@ -0,0 +1,21 @@
+
+# Contributing
+
+Thank you for your interest in contributing!
+
+## Before You Start
+
+If you plan to make major changes (especially new features or design changes), please open an issue or discussion before starting work. This helps ensure your effort aligns with the project's direction.
+
+## Submitting Code
+
+Please keep each pull request focused on a single purpose. Avoid mixing unrelated changes in one PR, as this can make reviewing and merging code more difficult.
+
+Please use the [Conventional Commits](https://www.conventionalcommits.org/) format for your commit messages whenever possible. This keeps our history clear and consistent.
+
+Before submitting code, please run the appropriate commands to check for errors and format your code.
+
+```bash
+pnpm check
+pnpm format
+```