Development - lstpsche/webring-rails GitHub Wiki

This page provides information for developers who want to contribute to or modify the Webring for Rails gem.

Setting Up the Development Environment

To set up the development environment:

  1. Clone the repository:

    git clone [email protected]:lstpsche/webring-rails.git
    cd webring-rails
    
  2. Install dependencies:

    bundle install
    
  3. Set up the test dummy app:

    bin/setup_dummy
    

Working with Migrations

After creating a new migration in the engine:

cd test/dummy
bin/rails db:migrate

This will run the migrations in the dummy app. You don't need to copy migrations to the dummy app, it looks for them in the engine.

Testing

As of now, there are no tests. Contributions to add test coverage are welcome!

Contributing

We welcome contributions to Webring for Rails! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch: git checkout -b my-new-feature
  3. Make your changes and add tests if possible
  4. Commit your changes: git commit -am 'Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request

License

The gem is available as open source under the terms of the MIT License.