smonette / everything-is-okay Goto Github PK

Running npm run readme while in app/ results in app/scripts/readme.js
generating a new README.md at app/README.md. This means that the actual README.md in the project’s root directory never gets updated.

Running npm run json while in app/ fails with the following error:

Error: ENOENT: no such file or directory, open '%MY_GIT_DIRECTORY%\everything-is-okay\app\README.md'
    at Error (native)

It appears that a variable in app/scripts/json.js incorrectly points to a non-existent app/README.md instead of the correct README.md, relatively located in the parent directory.

First, thanks for having instructions for contributing! Having these instructions helped me get started on contributing to this fun project.

Currently, contributors have two ways to contribute links to happiness (videos/gifs/etc) to this project. Depending on the contributor’s chosen method, that contributor needs to run a specific npm script. Regardless of the chosen method, both npm scripts need to be run in app/; otherwise, contributors will get an error stating that npm couldn’t find package.json.

Consider clarifying what steps a contributor should follow when they’ve decided how they’ll contributing their links of happiness. Doing this will ensure that README.md and app/everything-is-okay.json both continue to be updated whenever someone adds a link to happiness.