Skip to content
This repository has been archived by the owner on Jun 4, 2022. It is now read-only.

Latest commit

 

History

History
80 lines (56 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 1.72 KB

lumo logo

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  • Search GitHub for an open or closed PR. You don't want to duplicate effort. Write on the Slack #lumo channel if unsure.

  • Create your patch including appropriate test cases.

  • When finished, run the pre-compilation tests:

    yarn lint
    yarn type:check
    yarn test
    boot test
  • Compile lumo:

    boot release
  • Run the CLJS test suite against ./build/lumo (Linux or Windows):

    ./scripts/test-build
    scripts/test-build.bat
  • Add your PR changes to CHANGELOG.md, including the relevant link to either the issue or the PR itself.

  • In GitHub, open a pull request to lumo:master.

  • If we suggest changes then:

    • Make the required updates (please).
    • Re-run the test suites to ensure tests are still passing.
    • Rebase your branch if necessary and force push to your GitHub repository (this will update your PR).

Thank you for your contribution!

Development workflow

In order to start watch-compilation use:

boot dev

Then in another terminal execute the following for a plain dev REPL with autocaching:

yarn dev

Or this other command for a dev REPL that includes the test suite on the classpath:

yarn test-dev

The latter repl is useful for trying out failing tests individually:

cljs.user=> (require 'lumo.repl-tests)
nil
cljs.user=> (in-ns 'lumo.repl-tests)
lumo.repl-tests=> (t/test-var #'test-apropos)
nil
;; hopefully :)