Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
122 lines (73 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

122 lines (73 loc) · 3.88 KB

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.

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

System dependencies

The script folder contains some useful scripts to help you set up the development environment.

To install the system dependencies, run the following script:

./script/bootstrap

For Windows, you can run the following command in PowerShell:

.\script\install-window.ps1

Run story

There are a lot of UI test cases in the crates/story folder, if you change the existing features you can run the tests to make sure they are working.

Use cargo run to run the complete story examples to display them all in a gallery of GPUI components.

cargo run

Run single example

There is also available some split examples, run cargo run --example to see the available examples.

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:

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.

Profile the performance

When you change the rendering code, please profile the performance to make sure the FPS is still good.

You can use MTL_HUD_ENABLED=1 environment variable to enable the Metal HUD to see the FPS and other performance metrics.

MTL_HUD_ENABLED=1 cargo run

NOTE: Only available on macOS with Metal backend, and the FPS is up limited your monitor refresh rate, usually 60 or 120.

Use Samply to profile the the performance

You can use Samply to profile the performance of the application to get more detailed information.

samply record cargo run

Use samply record command to start rust development, and do some operations in the app that you want to profile, then stop the terminal with ctrl-c, then samply will open the browser to show the profile results.

Release crates version

When we are ready to release a new version, please follow the steps below:

Use the script to bump the version(Recommended)

./script/bump-version.sh x.y.z

Manually bump the version

  1. Run cargo set-version to set the new version for all crates.

    cargo set-version x.y.z

  2. Git Commit the changes with message Bump vx.y.z.

  3. Create a new git tag with the version vx.y.z and push main branch and the tag to remote.

    git tag vx.y.z
git push origin vx.y.z

  4. Then GitHub Actions will automatically publish the crates to crates.io and create a new release in GitHub.