Skip to content

Revise contributing guide and link to documentation #471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
djalmaaraujo merged 1 commit into from
May 7, 2026
+1 −28
Merged

Revise contributing guide and link to documentation #471

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 1 addition & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1 @@
Rails need a plug n play system for creating streamlined ui components.

Phlex looks fun and fast, so I thought I'd start creating ui components with it.

## Contributing - Local Development Setup

### Install the Gem Locally

To contribute to this project, it's recommended to install the gem locally and point to it in your Gemfile:

```ruby
gem "ruby_ui", path: "../ruby_ui"
```

## Working with Components

### Component Development Workflow

1. Eject the component you want to modify using the generator:
```bash
rails generate ruby_ui:component combobox
```
2. Make your desired changes to the ejected component
3. Once you're satisfied with the modifications, integrate the component back into the gem in the appropriate location

This workflow allows you to iterate quickly on components while maintaining the gem's structure.

Would you like me to expand on any part of the contributing guide?
Moved to https://github.com/ruby-ui/ruby_ui/tree/main/docs.