Skip to content

Latest commit

 

History

History
143 lines (99 loc) · 5.3 KB

CONTRIBUTING.md

File metadata and controls

143 lines (99 loc) · 5.3 KB
Raw

Contributing to Sorbet Rails

Thank you for taking the time to contribute to this project!

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

This project is licensed under the MIT license.

Need Help?

If you are trying to integrate Sorbet into your project, consider these venues:

If you've come here to report an issue, you're in the right place!

Reporting Bugs and Adding Functionality

We're excited you'd like to contribute to Sorbet Rails!

When reporting a bug, please include:

  • Steps to reproduce
  • The versions of Ruby, Ruby on Rails, Sorbet, and this gem that you are using
  • A test case, if you are able

If you believe you have found a security issue, please contact us at [email protected] rather than filing an issue here.

When proposing new functionality, please include test coverage. We're also available in the Sorbet Slack #rails channel to discuss your idea before you get started, just to make sure everyone is on the same page.

Local Development

  1. Clone sorbet-rails locally:
❯ git clone https://github.com/chanzuckerberg/sorbet-rails.git
  1. Point your project's Gemfile to your local clone:
# -- Gemfile --

gem 'sorbet-rails', path: "~/sorbet-rails"

The most important files are:

Tests

Tests are written using RSpec. Each pull request is run against multiple versions of both Ruby and Ruby on Rails. A code coverage report is also generated.

Running Tests

You can run tests using bundle exec rake.

By default, tests will run against a Rails 5.2.x test application.

To run the tests against all supported Rails branches, use:

❯ ./spec/bin/run_all_specs.sh

You can also switch to a version of Rails with RAILS_VERSION:

❯ RAILS_VERSION=5.2 ./spec/bin/run_spec.sh
❯ RAILS_VERSION=6.0 ./spec/bin/run_spec.sh
❯ RAILS_VERSION=6.1 ./spec/bin/run_spec.sh

Debugging

It is possible to run only one file's tests:

❯ bundle exec rspec spec/model_rbi_formatter_spec.rb

Or a specific test in a file:

❯ bundle exec rspec spec/model_rbi_formatter_spec.rb:28

For debugging, you could use byebug, which is installed in development mode. If you're not familiar with byebug, add byebug where you want execution to stop, which will then start a debugger. For more, check out the byebug guide.

Writing Tests

Tests are in the _spec.rb files in the spec/ directory. Sorbet's srb tc test cases are in spec/generators/sorbet_test_cases.rb.

Rails apps are stored in spec/support/. All models, controllers, helpers, migrations, and any other shared code comes from spec/generators/rails-template.rb. The only exception to this is spec/generators/sorbet_test_cases.rb, which is copied into each app with cp.

The rails-template.rb file uses the Rails Application Template functionality included in Rails. You can then regenerate each Rails app from the same file using bundle exec rake update_spec:v5_0, bundle exec rake update_spec:v5_1, etc. (or just bundle exec rake update_spec:all.

Expected Output

If your new tests make changes to the expected output, you can update the expected output by running:

❯ ./spec/bin/update_test_data.sh

Only do this once you're confident that your code is correct, because it will update the expected test data stored in spec/test_data/ based on your current code, and all tests will then pass.

If you want to update sorbet_test_cases.rb, you can run bundle exec rake update_spec:sorbet_test_cases to copy the file from spec/generators/sorbet_test_cases.rb into each of the Rails apps in spec/support/.