Skip to content

Latest commit

 

History

History
115 lines (84 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

115 lines (84 loc) · 3.16 KB

Contributing to turbo_stream_button

We love pull requests from everyone. By participating in this project, you agree to abide by the thoughtbot code of conduct.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code (no patch is too small : fix typos, add comments, etc.)
  • by refactoring code
  • by closing issues
  • by reviewing patches

Submitting an Issue

  • We use the GitHub issue tracker to track bugs and features.
  • Before submitting a bug report or feature request, check to make sure it hasn't already been submitted.
  • When submitting a bug report, please include a [reproduction script] and any other details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system.

Cleaning up issues

  • Issues that have no response from the submitter will be closed after 30 days.
  • Issues will be closed once they're assumed to be fixed or answered. If the maintainer is wrong, it can be opened again.
  • If your issue is closed by mistake, please understand and explain the issue. We will happily reopen the issue.

Submitting a Pull Request

  1. Fork the official repository.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add an entry to the CHANGELOG.md
  5. Add, commit, and push your changes.
  6. Submit a pull request.

Notes

  • Please add tests if you changed code. Contributions without tests won't be accepted.
  • If you don't know how to add tests, please put in a PR and leave a comment asking for help. We love helping!
  • Please don't update the Gem version.

Setting up

bundle install
yarn install

Running the test suite

The default rake task will run the full test suite and standard:

bin/rails test:all

You can also run a single group of tests (unit or system)

bin/rails test
bin/rails test:system

To run an individual test, you can provide a path and line number:

bin/rails test/path/to/test.rb:123

You can run tests with a specific version of rails by setting the RAILS_VERSION environment variable, then executing bundle install:

export RAILS_VERSION=7.0
rm Gemfile.lock
bundle install
bin/rails test:all

To execute the test suite against main, set RAILS_VERSION to main:

export RAILS_VERSION=main
bundle install
bin/rails test:all

Formatting

Use standard to automatically format your code:

bin/rails standard:fix

Inspired by https://github.com/thoughtbot/factory_bot/blob/master/CONTRIBUTING.md