Skip to content
This repository has been archived by the owner on Jul 24, 2019. It is now read-only.

Commit

Permalink
Add How to Contribute to README
Browse files Browse the repository at this point in the history
  • Loading branch information
PEZ committed Dec 23, 2018
1 parent 4b17bdf commit 6afe4d9
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 3 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 -> Better than Tomorrow

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,28 @@

Some of the functionality of the [Calva] family of Visual Studio Code extensions is provided by this library. It is built as an npm module, [@cospaia/calva-lib](https://www.npmjs.com/package/@cospaia/calva-lib), but not meant for public consumption.

See the [How to Contribute](https://github.com/BetterThanTomorrow/calva/wiki/How-to-Contribute) wiki page for Calva for instruction on how to hack on this.

Also feel invited to join the [`#calva-dev` channel](https://clojurians.slack.com/messages/calva-dev/) channel in the Clojurians Slack.
## How to Contribute to calva-lib

❤️
1. Clone your fork
1. Most often you'll be branching off of `master` (the main branch).
1. `npm install` (This will install, amongst other things, `shadow-cljs`)
1. Open the project root directory in VS Code. (You are using VS Code and Calva, right?)

The dev process is like so:
1. In VS Code: **Run Build Task…**. This will run `shadow-cljs` and make it watch `:test` and `:calva-lib`.
1. Check the task Output pane and notice that tests are run.
1. Connect Calva and choose the `node-repl` for your CLJS repl (it won't work with any of the build repls, unfortunately).
1. Hack away. Every time you save, the tests are run.
1. Add/remove/modify any relevant test.
1. Test the changes in the actual extension (see below about that setup).
1. Assuming it is setup this means switching to the *Calva* window and restart the extension host process (then switch to the extension host window and do your manual testing).

For testing the changes to the actual extensions, see the relevant **How to Contribute** page:

* [Calva](https://github.com/BetterThanTomorrow/calva/wiki/How-to-Contribute)
* [Calva Formatter](https://github.com/BetterThanTomorrow/calva-fmt/wiki/How-to-Contribute)
* (Soon also [Calva Paredit](https://github.com/BetterThanTomorrow/calva-paredit))

## Happy hacking! ❤️
Please feel invited to join the [`#calva-dev` channel](https://clojurians.slack.com/messages/calva-dev/) channel on the Clojurians Slack.

0 comments on commit 6afe4d9

Please sign in to comment.