Bug reports and pull requests are welcome on GitHub at https://github.com/primer/view_components. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Setting up
Run
script/setup
To install all necessary dependencies.
Running tests
To run the full test suite:
bundle exec rake
Writing documentation
Documentation is written as YARD comments directly in the source code, compiled into Markdown via rake docs:build and served by Doctocat.
Storybook / Documentation
To run Storybook and the documentation site, run:
script/dev
Note: Overmind is required to run script/dev.
Developing with another app
In your Gemfile, change:
gem "primer_view_components"
to
gem "primer_view_components", path: "path_to_the_gem" # e.g. path: "~/primer/view_components"
Then, bundle install to update references. You'll now be able to see changes from the gem without having to build it.
Remember that restarting the Rails server is necessary to see changes, as the gem is loaded at boot time.
To minimize the number of restarts, we recommend checking the component in Storybook first, and then when it's in a good state,
you can check it in your app.
Deploying to Heroku
We have both staging and production environments. To deploy Storybook to Heroku, run the following in #primer-view-components-ops:
.deploy primer-view-components</branch> to <environment>