Skip to content

Commit 47b1a09

Browse files
authored
add a line re: committing package.json (#260)
1 parent 0302e29 commit 47b1a09

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ Follow these instructions for contributing new recipes. The Goal headers indicat
6565
- **Note**: you can only install dependencies that exist in the latest package set release; you cannot add or override packages in `packages.dhall` (see Principles section for more context).
6666
1. Install needed `npm` dependencies via `npm i <packageName>`. These will be installed to the root folder's `node_modules` folder, not a corresponding folder in the recipe.
6767
- If you do install `npm` dependencies for your recipe, please state which libraries were installed in the recipe's `README.md` file.
68+
- You can commit and include with your PR the resulting update to `package.json` (you don't need to commit the `package-lock.json`, however)
6869
- If you want your recipe to be compatible with TryPureScript, the npm dependency must be [listed here](https://github.com/purescript/trypurescript/blob/master/client/src/Try/Shim.purs). If it's not listed, open a PR to add it to that file.
6970
1. Implement your recipe.
7071
- If you add any new modules, always start the module name with your recipe's "Unique Recipe Name" (e.g. `MyNewRecipe.Foo`, `MyNewRecipe.Module.Path.To.Cool.Types`).

0 commit comments

Comments
 (0)