From dc3de9fec92e9f19deea2e499566f1563c8953f4 Mon Sep 17 00:00:00 2001 From: Cirdes Henrique Date: Sun, 11 May 2025 13:44:25 -0300 Subject: [PATCH 1/3] Add contributing file --- CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..dc7a0ed4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Contributing to RubyUI + +Thank you for your interest in contributing to RubyUI! This document provides guidelines for contributing to the project. + +## Development Setup + +We recommend using the provided devcontainer to set up your development environment. This ensures a consistent environment for all contributors. + +1. Make sure you have Docker +2. Clone the repository +3. Open the project in you editor +4. Select "Reopen in Container" if you are using VSCode or any other method to run the project +5. The devcontainer will set up everything you need to start developing + +## Contribution Process + +1. Fork the repository +2. Create a new branch for your changes +3. Make your changes +4. Run tests to ensure your changes don't break existing functionality: `bundle exec rake test` +5. Run the linter to ensure code quality: `bundle exec rake standard` +6. Submit a Pull Request to the main repository + +## Focus Areas + +We prioritize: +- Improving existing components rather than adding new ones +- Preserving the shadcn look and feel +- Enhancing documentation +- Fixing bugs + +## Code Standards + +We follow Standard Ruby conventions for code style. The CI pipeline runs `standard` to verify code quality. + +## Testing + +While we don't have specific test coverage requirements, all contributions should include tests for new functionality and ensure existing tests pass. + +## Documentation + +If your changes include new components, modify how components should be used, or add new behaviors, it is highly recommended to also open a PR on the [ruby-ui/web](https://github.com/ruby-ui/web) repository. This ensures the documentation website stays up-to-date with the latest component changes. + +Thank you for contributing to make RubyUI better! \ No newline at end of file From 2f8fc2835d4fb48118bcd5c1f137191d35e76a4f Mon Sep 17 00:00:00 2001 From: Cirdes Date: Mon, 19 May 2025 13:52:45 -0400 Subject: [PATCH 2/3] Update CONTRIBUTING.md Co-authored-by: stephann <3025661+stephannv@users.noreply.github.com> Signed-off-by: Cirdes --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc7a0ed4..dff02062 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ We recommend using the provided devcontainer to set up your development environm 2. Create a new branch for your changes 3. Make your changes 4. Run tests to ensure your changes don't break existing functionality: `bundle exec rake test` -5. Run the linter to ensure code quality: `bundle exec rake standard` +5. Run the linter to ensure consistent code formatting: `bundle exec rake standard` 6. Submit a Pull Request to the main repository ## Focus Areas From 3dd91e73e738d8bc07e9ddc13eca2a17605cfa65 Mon Sep 17 00:00:00 2001 From: Cirdes Date: Mon, 19 May 2025 13:52:50 -0400 Subject: [PATCH 3/3] Update CONTRIBUTING.md Co-authored-by: stephann <3025661+stephannv@users.noreply.github.com> Signed-off-by: Cirdes --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dff02062..7dba2073 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ We prioritize: ## Code Standards -We follow Standard Ruby conventions for code style. The CI pipeline runs `standard` to verify code quality. +We follow Standard Ruby conventions for code style. The CI pipeline runs `standard` to ensure consistent code formatting. ## Testing