Skip to content

Latest commit

 

History

History
112 lines (85 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

112 lines (85 loc) · 3.45 KB
Raw

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by triaging bug reports
  • by writing or editing documentation
  • by writing specifications
  • by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
  • by refactoring code
  • by fixing issues
  • by reviewing patches
  • by suggesting new features
  • financially

Development

Running tests locally

To run the test suite, you need Google Chrome and ImageMagick (or GraphicsMagick).

Example installation on macOS using Homebrew:

# install imagemagick:
brew install imagemagick
# install google chrome with cask:
brew install brew-cask
brew cask install google-chrome

Example installation on Ubuntu:

# install imagemagick:
sudo apt update -y && sudo apt install imagemagick -y
# install google chrome:
sudo apt update -y && wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb && sudo apt install ./google-chrome-stable_current_amd64.deb -y

Then you need to do this one-time setup:

bundle install
yarn install
# install dependencies for each appraisal:
bundle exec appraisal install
# precompile assets in the dummy app:
cd spec/dummy_app && yarn install && yarn build && yarn build:css && cd -

Then you will be able to run the specs:

bundle exec appraisal rails-7.0 rspec

Tests run against multiple versions of Rails

In CI, we use appraisal to run tests against multiple versions of Rails. The gemfiles/ directory contains the Gemfiles used to create the CI build matrix. See the GitHub Actions configuration for more details on what Ruby versions run what Rails versions.

Getting Help

We use a mailing list for user support. If you've got a "how do I do this?" or "this doesn't seem to work the way I expect" type of issue or just want some help, please post a message to the mailing list.

Submitting an Issue

If you're confident that you've found a bug in rails_admin, please open an issue, but check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a branch.
  3. Add specs for your unimplemented feature or bug fix.
  4. Run bundle exec rake spec. If your specs pass, return to step 3.
  5. Implement your feature or bug fix.
  6. Run bundle exec rake default. If your specs fail, return to step 5.
  7. Run open coverage/index.html. If your changes are not completely covered by your tests, return to step 3.
  8. Add, commit, and push your changes.
  9. Submit a pull request.