dan/gpui-component
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update contributing for UI guides. (#1215)

Browse source
This commit is contained in:
Jason Lee 2025-09-08 10:16:11 +08:00 committed by GitHub
parent f35398d797
commit 62122d5f41
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 31 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
CONTRIBUTING.md
View file

@ -1,10 +1,24 @@
## Contributing Guide
# Contributing Guide
Contributions are welcome, if you find some bugs or have some ideas, please open an issue or submit a pull request.
Please ensure that you are using clean code, following the coding style and code organization in existing code, and make sure all the tests pass.
Please submit one PR that does one thing, this is important, and helps us to review your code more easily and push to merge fast.
Please submit **one PR that does one thing**, this is important, and helps us to review your code more easily and push to merge fast.
## AI Assistance
> 🤖 When you submit PR, please point out which parts are generated by AI, if any.
All code generated by AI must be reviewed and tested by humans, and should follow the same coding style and code organization as existing code.
The AI generated code without refactoring will be rejected.
## Code Style
Before you start to write code, please read the existing code to follow the same coding style and code organization.
- Inspired by existing code or refer to macOS/Windows controls API design to name your functions, properties, structs etc.
## Development and Testing
@ -25,3 +39,18 @@ There is also available some split examples, run `cargo run --example` to see th
```bash
cargo run --example table
```
## UI Guides
GPUI Component is inspired by macOS and Windows controls, combined with shadcn/ui design for a modern experience.
So please refer to the following UI guides when you design or change the UI components:
- [Apple Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/)
- [Microsoft Fluent Design System](https://learn.microsoft.com/en-us/windows/apps/design/)
- [shadcn/ui](https://ui.shadcn.com/)
### Rules
- Use `default` mouse cursor not `pointer` for buttons, unless it's a link button, we are building desktop apps, not web apps.
- Use `md` size for most cases and as the default.