76 lines (54 loc) · 1.27 KB

Contributing to Rails Console Pro

Thank you for your interest in contributing to Rails Console Pro!

Development Setup

Fork and clone the repository:

git clone https://github.com/harshumaretiya/rails_console_pro.git
cd rails_console_pro

Install dependencies:
```
bundle install
```
Run tests:
```
bundle exec rspec
```
Build the gem:
```
gem build rails_console_pro.gemspec
```

Making Changes

Create a feature branch:
```
git checkout -b feature/my-feature
```
Make your changes and add tests
Ensure all tests pass:
```
bundle exec rspec
```
Run RuboCop:
```
bundle exec rubocop
```

Commit your changes:

git commit -m "Add feature: description"

Push and create a pull request

Code Style

Follow Ruby style guide
Use RuboCop for linting
Write tests for new features
Update documentation as needed

Testing

Write tests for all new features
Ensure edge cases are covered
Maintain or improve test coverage

Documentation

Update README.md for user-facing changes
Update CHANGELOG.md for all changes
Add code comments for complex logic

Questions?

Open an issue or start a discussion!