dillonkearns/elm-pages-v3-beta
1
1
Fork 0
mirror of https://github.com/dillonkearns/elm-pages-v3-beta.git synced 2024-12-25 12:52:27 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Dillon Kearns 2019-10-19 09:58:52 -07:00 committed by GitHub
parent 3a47af0fbd
commit eb5b7b7eb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -18,6 +18,25 @@ cd examples/docs
npm start # runs elm-pages develop with the NPM and Elm package code in your repo
```
### Running against your own local `elm-pages` project
If you want to make changes to the `elm-pages` code generation CLI and try running them against your own local project, you can do so by running these commands:
```shell
cd /path/to/your/local/elm-pages/site
npm install /path/to/cloned/elm-pages
# For example, on my machine I can run: npm install ~/src/github.com/dillonkearns/elm-pages
```
This adds something like this to your `devDepdnencies`:
```json
"elm-pages": "file:../..",
```
That has been working very reliably for me, so I can make tweaks and it picks them up right away. I just need to re-run npm start to start the watcher again.
Just be sure to change it back in your local project when you're done experimenting by running `npm install --save-dev elm-pages`.
## Making pull requests
I really appreciate pull requests, but I always like to start with a discussion first. If you don't mind, please ping me (either on the Elm slack, Twitter, or a Github issue) and start a discussion about your idea before diving in to make a pull request. It's always good to make sure we're on the same page to minimize extra work.