Contributing

.node-version

@@ -1 +1 @@
-18
+18.14.0

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+## Getting started
+Create your own fork, and develop changes on a new branch.
+It's expected you add tests, and lint and format your code before submitting a PR.
+
+### Node
+Ensure you have a compatible node version mentioned in `.node-version`
+
+For example, with nodenv:
+`nodenv install`
+
+### Packages
+Using yarn package manager:
+`yarn install`
+
+### Dev server
+`yarn dev`
+
+### Running tests
+Optionally specify file or folder for a specific test.
+`yarn test [path]`
+
+### Test with local project
+
+Generate dist files with: `yarn build`
+
+Then, in your other project directory:
+
+Include with local file reference: `yarn add file:/path/to/stimulus-rails-nested-form`
+
+Update reference to this dir, eg:
+```js
+import NestedForm from '/path/to/stimulus-rails-nested-form/dist/stimulus-rails-nested-form.umd.js' // the default module entry point is broken for webpacker
+```
+
+### Linting and formatting
+`yarn lint`
+`yarn format`

README.md

@@ -17,6 +17,7 @@ See [stimulus-rails-nested-form documentation](https://www.stimulus-components.c
 ## 👷‍♂️ Contributing
 
 Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
+See [CONTRIBUTING.md] for more details.
 
 ## 📝 License