{"id":13416414,"url":"https://github.com/komposable/komponent","last_synced_at":"2025-10-04T02:08:26.425Z","repository":{"id":54758035,"uuid":"113447555","full_name":"komposable/komponent","owner":"komposable","description":"An opinionated way of organizing front-end code in Ruby on Rails, based on components","archived":false,"fork":false,"pushed_at":"2024-10-08T21:57:30.000Z","size":404,"stargazers_count":425,"open_issues_count":28,"forks_count":31,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-09-03T16:53:17.916Z","etag":null,"topics":["component-based","design-systems","rails5","styleguides","webpacker"],"latest_commit_sha":null,"homepage":"http://komponent.io","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/komposable.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-07T12:21:15.000Z","updated_at":"2025-07-17T18:28:31.000Z","dependencies_parsed_at":"2024-12-05T13:02:07.576Z","dependency_job_id":"2a1e8bb9-94d2-46e0-a21d-3a014675a164","html_url":"https://github.com/komposable/komponent","commit_stats":{"total_commits":240,"total_committers":17,"mean_commits":"14.117647058823529","dds":0.5083333333333333,"last_synced_commit":"404fe30830dfb0638611c0cde1a4ba6b035fff34"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/komposable/komponent","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/komposable%2Fkomponent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/komposable%2Fkomponent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/komposable%2Fkomponent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/komposable%2Fkomponent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/komposable","download_url":"https://codeload.github.com/komposable/komponent/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/komposable%2Fkomponent/sbom","scorecard":{"id":566730,"data":{"date":"2025-08-11","repo":{"name":"github.com/komposable/komponent","commit":"404fe30830dfb0638611c0cde1a4ba6b035fff34"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.6,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":8,"reason":"Found 23/26 approved changesets -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/komposable/komponent/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/komposable/komponent/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/komposable/komponent/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/komposable/komponent/test.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:53","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T15:10:43.988Z","repository_id":54758035,"created_at":"2025-08-20T15:10:43.988Z","updated_at":"2025-08-20T15:10:43.988Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278254466,"owners_count":25956604,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["component-based","design-systems","rails5","styleguides","webpacker"],"created_at":"2024-07-30T21:00:58.483Z","updated_at":"2025-10-04T02:08:26.379Z","avatar_url":"https://github.com/komposable.png","language":"Ruby","funding_links":[],"categories":["Ruby","View components","View helpers"],"sub_categories":[],"readme":"# \u003cimg alt=\"Komponent\" src=\"https://raw.github.com/ouvrages/komponent/master/logo.svg?sanitize=true\" width=\"200\" height=\"40\" /\u003e\n[![Tests](https://github.com/komposable/komponent/workflows/Tests/badge.svg)](https://github.com/komposable/komponent/actions)\n![GitHub release](https://img.shields.io/github/release/komposable/komponent.svg)\n[![Maintainability](https://api.codeclimate.com/v1/badges/36d6dcf883df8f63893a/maintainability)](https://codeclimate.com/github/komposable/komponent/maintainability)\n![Coveralls github](https://img.shields.io/coveralls/github/komposable/komponent.svg)\n\n**Komponent** implements an opinionated way of organizing front-end code in Ruby on Rails, based on _components_.\n\n----\n\n:wave: **HEADS UP!** The future of this gem is currently [being discussed](https://github.com/komposable/komponent/issues/169). Please have your say!\n\n----\n\nEach component has its own folder, containing a Ruby module, a partial, a stylesheet and a JavaScript file.\n\nKomponent relies heavily on webpacker to manage dependencies and generate the production JS and CSS files.\n\nThis README examples are written in Slim, but Komponent is compatible with:\n\n- your preferred templating language (Slim, Haml, erb)\n- your stylesheet language of choice (Sass, SCSS, CSS, PostCSS)\n\nThis gem has been inspired by our Rails development practices at [Ouvrages](https://ouvrages-web.fr) and [Etamin Studio](https://etaminstudio.com), and the (excellent) [_Modern Front-end in Rails_](https://evilmartians.com/chronicles/evil-front-part-1) article from Evil Martians.\n\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n- [Compatibility](#compatibility)\n- [Getting started](#getting-started)\n- [Usage](#usage)\n  - [Passing variables](#passing-variables)\n  - [Passing options](#passing-options)\n    - [Component caching](#component-caching)\n  - [Passing a block](#passing-a-block)\n  - [Properties](#properties)\n  - [Helpers](#helpers)\n  - [Component partials](#component-partials)\n  - [Namespacing components](#namespacing-components)\n  - [Stimulus integration](#stimulus-integration)\n  - [Internationalization](#internationalization)\n    - [Available locales configuration](#available-locales-configuration)\n  - [Styleguide](#styleguide)\n  - [Configuration](#configuration)\n    - [Change default root path](#change-default-root-path)\n    - [Default options for the generators](#default-options-for-the-generators)\n    - [Change default stylesheet engine](#change-default-stylesheet-engine)\n    - [Force default templating engine](#force-default-templating-engine)\n    - [Additional paths](#additional-paths)\n- [Contributing](#contributing)\n- [Releasing a new version](#releasing-a-new-version)\n- [License](#license)\n\u003c/details\u003e\n\n## Compatibility\n\n- Ruby 2.5+\n- Rails 5.0+\n- Webpacker 3.0.0+\n\n## Getting started\n\n```ruby\n# Gemfile\n\ngem 'komponent'\n```\n\nRun the following command to set up your project instantly:\n\n```sh\nrails generate komponent:install\n```\n\nThis command will:\n\n* check that the dependencies (currently, webpacker) are installed\n* rename the `app/javascript` folder to `frontend` and modify webpacker config accordingly\n* create the `frontend/components` folder where you will put your component\n* create the `frontend/components/index.js` file that will list your components and `import` it in `frontend/packs/application.js`\n\n## Usage\n\nGenerate a new component with the `component` generator:\n\n```sh\nrails generate component button\n```\n\nThen, render it in your views with the `component` helper (or its alias `c`).\n\n```slim\n/ app/views/pages/home.html.slim\n\n= component 'button'\n= c 'button'\n```\n\nOr, directly from your controllers:\n\n```ruby\n# app/controllers/pages_controller.rb\n\ndef home\n  render html: helpers.component('home')\nend\n```\n\nMake sure to include javascript pack tag and stylesheet pack tag in your application layout file, for instance:\n\n```slim\n/ app/views/layouts/application.html.slim\n\ndoctype html\nhtml\n  head\n    = stylesheet_pack_tag 'application'\n\n  body\n    = yield\n    = javascript_pack_tag 'application'\n```\n\nCheck [Webpacker documentation](https://github.com/rails/webpacker) for further information.\n\n### Passing variables\n\nYou can pass `locals` to the helper. They are accessible within the component partial, as instance variables. Additionally, the entire `locals` hash is made available through a `properties` helper method.\n\n```slim\n/ app/views/pages/home.html.slim\n\n= component 'button', text: 'My button'\n```\n\n```slim\n/ frontend/components/button/_button.html.slim\n\n.button\n  = @text\n```\n\n### Passing options\n\n#### Component caching\n\nKomponent relies on [Rails Low-level caching](http://guides.rubyonrails.org/caching_with_rails.html#low-level-caching).\n\nYou can cache the component by passing the `cached: true` option. The cache will expire when the locals, options or block change.\nIf you want better control of the cache expiration, you can provide a custom `cache_key`. When the `cache_key` changes, the cache will be cleared.\n\n```slim\n/ app/views/pages/home.html.slim\n\n/ Cache the component based on its locals\n= component \"button\", { text: 'Click here' }, cached: true\n\n/ or cache the component with a specific key, such as the last update of a model\n= component \"button\", { text: 'Click here' }, cached: true, cache_key: @product.updated_at\n```\n\n### Passing a block\n\nThe component also accepts a `block`. To render the block, just use the standard `yield`.\n\n```slim\n/ app/views/pages/home.html.slim\n\n= component 'button'\n  span= 'My button'\n```\n\n```slim\n/ frontend/components/button/_button.html.slim\n\n.button\n  = yield\n```\n\nYou can check if the component has been called with a block using the `block_given_to_component?` helper from within the component.\n\n### Properties\n\nEach component comes with a Ruby `module`. You can use it to set properties:\n\n```ruby\n# frontend/components/button/button_component.rb\n\nmodule ButtonComponent\n  extend ComponentHelper\n  \n  property :href, required: true\n  property :text, default: 'My button'\nend\n```\n\n```slim\n/ frontend/components/button/_button.html.slim\n\na.button(href=@href)\n  = @text\n```\n\n### Helpers\n\nIf your partial becomes too complex and you want to extract logic from it, you may want to define custom helpers in the `ButtonComponent` module:\n\n```ruby\n# frontend/components/button/button_component.rb\n\nmodule ButtonComponent\n  extend ComponentHelper\n  \n  property :href, required: true\n  property :text, default: 'My button'\n\n  def external_link?\n    @href.starts_with? 'http'\n  end\nend\n```\n\n```slim\n/ frontend/components/button/_button.html.slim\n\na.button(href=@href)\n  = @text\n  = ' (external link)' if external_link?\n```\n\n```slim\n/ app/views/pages/home.html.slim\n\n= component \"button\", text: \"My button\", href: \"http://github.com\"\n```\n\n### Component partials\n\nYou can also choose to split your component into partials. In this case, we can use the default `render` helper to render a partial, stored inside the component directory.\n\n```slim\n/ frontend/components/button/_button.html.slim\n\na.button(href=@href)\n  = @text\n  - if external_link?\n    = render 'suffix', text: 'external link'\n```\n\n```slim\n/ frontend/components/button/_suffix.html.slim\n\n= \" (#{text})\"\n```\n\n### Namespacing components\n\nTo organize different types of components, you can group them in namespaces when you use the generator:\n\n```sh\nrails generate component admin/header\n```\n\nThis will create the component in an `admin` folder, and name its Ruby module `AdminHeaderComponent`.\n\n### Stimulus integration\n\nKomponent supports [Stimulus](https://github.com/stimulusjs/stimulus) \u003e= 1.0.\n\nYou can pass `--stimulus` to both generators to use Stimulus in your components.\n\n```sh\nrails generate komponent:install --stimulus\n```\n\nThis will `yarn add stimulus` and create a `stimulus_application.js` in the `frontend` folder.\n\n```sh\nrails generate component button --stimulus\n```\n\nThis will create a component with an additional `button_controller.js` file, and define a `data-controller` in the generated view.\n\n### Internationalization\n\nIn case your component will contain text strings you want to localize, you can pass the `--locale` option to generate localization files in your component directory.\n\n```sh\nrails generate component button --locale\n```\n\nThis will create a `yml` file for each locale (using `I18n.available_locales`). In your component, the `t` helper will use the same [\"lazy\" lookup](http://guides.rubyonrails.org/i18n.html#lazy-lookup) as Rails.\n\n```slim\n/ frontend/components/button/_button.html.slim\n\n= a.button(href=@href)\n  = @text\n  = render('suffix', text: t(\".external_link\")) if external_link?\n```\n\n```yml\n# frontend/components/button/button.en.yml\n\nen:\n  button_component:\n    external_link: external link\n```\n\n```yml\n# frontend/components/button/button.fr.yml\n\nfr:\n  button_component:\n    external_link: lien externe\n```\n\n#### Available locales configuration\n\nYou can whitelist the locales you use by setting this into an initializer, as explained in the [\"official guide\"](http://guides.rubyonrails.org/i18n.html#configure-the-i18n-module):\n```ruby\nI18n.available_locales = [:en, :fr]\n```\n\n\u003e If you have the `rails-i18n` gem in your `Gemfile`, you should whitelist locales to prevent creating a lot of\n\u003e locale files when you generate a new component.\n\n### Styleguide\n\nKomponent includes a basic styleguide engine that you can use in your project to document your components.\n\n![Komponent styleguide UI](https://user-images.githubusercontent.com/38524/41193700-45909330-6c10-11e8-87b7-59e628529200.png)\n\nTo set it up, you can use the generator:\n\n```sh\nrails generate komponent:styleguide\n```\n\nThis command will:\n\n* copy the styleguide components (`komponent/container`, `komponent/footer`, `komponent/header` and `komponent/sidebar`) to your components folder, so you can customize them\n* add a new `komponent.js` pack to your packs folder\n* mount the engine in your routes\n\nThen, for each component, you can describe it and render examples for each state in the `_example.html.slim` file from the component folder. The engine will then render it on the component page.\n\nIf you have existing components, you can generate all their example files at once with:\n\n```sh\nrails generate komponent:examples\n```\n\nFinally, visit `http://localhost:3000/styleguide` to access your styleguide.\n\n### Configuration\n\n#### Change default root path\n\nYou can change the default root path (`frontend`) to another path where Komponent should be installed and components generated. You need to change `komponent.root` in an initializer.\n\n```rb\nRails.application.config.komponent.root = Rails.root.join('app/frontend')\n```\n\n#### Default options for the generators\n\nYou can configure the generators in an initializer or in `application.rb`, so you don't have to add `--locale` and/or `--stimulus` flags every time you generate a fresh component.\n\n```rb\nconfig.generators do |g|\n  g.komponent stimulus: true, locale: true # both are false by default\nend\n```\n\n#### Change default stylesheet engine\n\nYou can configure the stylesheet engine used for generate stylesheet file, allowed values are `:css`, `:scss`, `:sass`.\n\n```rb\nRails.application.config.komponent.stylesheet_engine = :css # default value is :css\n```\n\n#### Force default templating engine\n\nIf for some reason your preferred templating engine is not detected by Komponent, you can force it by manually defining it in your config:\n\n```rb\nRails.application.config.generators.template_engine = :haml\n```\n\n#### Additional paths\n\nYou may want to use components in a gem, or a Rails engine, and expose them to the main app. In order to do that, you just have to configure the paths where Komponent will look for components.\n\nFrom a gem:\n\n```rb\nmodule MyGem\n  class Railtie \u003c Rails::Railtie\n    config.after_initialize do |app|\n      app.config.komponent.component_paths.append(MyGem.root.join(\"frontend/components\"))\n    end\n\n    initializer \"my_gem.action_dispatch\" do |app|\n      ActiveSupport.on_load :action_controller do\n        ActionController::Base.prepend_view_path MyGem.root.join(\"frontend\")\n      end\n    end\n\n    initializer 'my_gem.autoload', before: :set_autoload_paths do |app|\n      app.config.autoload_paths \u003c\u003c MyGem.root.join(\"frontend\")\n    end\n  end\n\n  private\n\n  def self.root\n    Pathname.new(File.dirname(__dir__))\n  end\nend\n```\n\nor from an engine:\n\n\n```rb\nmodule MyEngine\n  class Engine \u003c Rails::Engine\n    isolate_namespace MyEngine\n\n    config.after_initialize do |app|\n      app.config.komponent.component_paths.append(MyEngine::Engine.root.join(\"frontend/components\"))\n    end\n\n    initializer 'my_engine.action_dispatch' do |app|\n      ActiveSupport.on_load :action_controller do\n        ActionController::Base.prepend_view_path MyEngine::Engine.root.join(\"frontend\")\n      end\n    end\n\n    initializer 'my_engine.autoload', before: :set_autoload_paths do |app|\n      app.config.autoload_paths \u003c\u003c MyEngine::Engine.root.join('frontend')\n    end\n  end\nend\n```\n\nMake sure you add `komponent` to the runtime dependencies in your `gemspec`.\n\nIn order to compile packs from engine, and to use `javascript_pack_tag 'engine'`, you need to:\n\n- Create a pack file in main app\n\n```js\n// frontend/packs/engine.js\n\nimport 'packs/engine';\n```\n\n- Append engine frontend folder to `resolved_paths` in `config/webpacker.yml` from your main app\n\n```yml\nresolved_paths:\n  - engine/frontend\n```\n\n## Running tests\n\nRun all Cucumber features and unit tests with `bundle exec appraisal rake test`\n\nRun the full test matrix with `bundle exec appraisal rake test`\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/komposable/komponent.\n\n## Releasing a new version\n\n- Update the CHANGELOG (add a title and a date for the new version)\n- Update the version number in `lib/komponent/version`\n- Install the `gem-release` gem if you haven't already\n- Run `gem release --tag --push`\n- Create or update the release on Github with the same version number and copy-paste the description from the CHANGELOG\n\nPlease note:\n\nIf you're releasing a patch version (eg. from 2.0.1 to 2.0.2) you can run `gem bump patch --release --tag --push --sign` so you don't have to manually change the version number.\n\nIf you want to release a specific version (eg. beta, RC...), you can run `gem bump 3.0.0.beta1 --release --tag --push --sign`\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkomposable%2Fkomponent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkomposable%2Fkomponent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkomposable%2Fkomponent/lists"}