Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.34 KB

Contributing

Bug reports and contributions are welcome. Before starting work, please open an issue to discuss the problem you are trying to solve.

As you make changes, you can test them in the example project. Find instructions for running it in its README.

Other common development tasks are described here.

Upgrading @headlessui/react

  1. Update package.json "devDependencies"
  2. npm install
  3. Update src/deps.cljs :npm-deps
  4. Add new components to src/headlessui_reagent/core.clj
  5. Update example/package.json "dependencies"
  6. cd example && npm install
  7. Test changes in example project
  8. Update dev/build.clj headlessui-react-version

Deploy

Prepare

To prepare for a release, run bin/check-release. The script will report what you can do to finish preparing, or if the release is ready, return an exit code of 0.

It will check that you have done the following things:

  1. Proactively updated CHANGELOG.md
  2. Proactively updated package.json and ran npm install
  3. Commited
  4. Tagged commit

Release

Deploy to Clojars -- needs CLOJARS_USERNAME and CLOJARS_PASSWORD environment variables:

$ bin/clojars-release

The library will be deployed to clojars.org.