Skip to content

Commit 0b75a1e

Browse files
cirdesstephannv
andauthored
Add contributing file (#290)
* Add contributing file * Update CONTRIBUTING.md Co-authored-by: stephann <[email protected]> Signed-off-by: Cirdes <[email protected]> * Update CONTRIBUTING.md Co-authored-by: stephann <[email protected]> Signed-off-by: Cirdes <[email protected]> --------- Signed-off-by: Cirdes <[email protected]> Co-authored-by: stephann <[email protected]>
1 parent c8610db commit 0b75a1e

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing to RubyUI
2+
3+
Thank you for your interest in contributing to RubyUI! This document provides guidelines for contributing to the project.
4+
5+
## Development Setup
6+
7+
We recommend using the provided devcontainer to set up your development environment. This ensures a consistent environment for all contributors.
8+
9+
1. Make sure you have Docker
10+
2. Clone the repository
11+
3. Open the project in you editor
12+
4. Select "Reopen in Container" if you are using VSCode or any other method to run the project
13+
5. The devcontainer will set up everything you need to start developing
14+
15+
## Contribution Process
16+
17+
1. Fork the repository
18+
2. Create a new branch for your changes
19+
3. Make your changes
20+
4. Run tests to ensure your changes don't break existing functionality: `bundle exec rake test`
21+
5. Run the linter to ensure consistent code formatting: `bundle exec rake standard`
22+
6. Submit a Pull Request to the main repository
23+
24+
## Focus Areas
25+
26+
We prioritize:
27+
- Improving existing components rather than adding new ones
28+
- Preserving the shadcn look and feel
29+
- Enhancing documentation
30+
- Fixing bugs
31+
32+
## Code Standards
33+
34+
We follow Standard Ruby conventions for code style. The CI pipeline runs `standard` to ensure consistent code formatting.
35+
36+
## Testing
37+
38+
While we don't have specific test coverage requirements, all contributions should include tests for new functionality and ensure existing tests pass.
39+
40+
## Documentation
41+
42+
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.
43+
44+
Thank you for contributing to make RubyUI better!

0 commit comments

Comments
 (0)