Info on how to contribute

[tonypee]

Sorry if this is obvious, but i got a little stuck trying to branch and debug the project the other day, and will need to be able to fix bugs for our project, in case they arise. (currently having issues with focus)

Can someone please update a little in the readme on the process for running/testing code locally. I had issues trying to npm link the local repo into our project, as it threw errors. I tried to push to github and npm i from my branched github a version that merged all the other changes (before they were kindly merged) - and this also didnt work. Maybe the build for npm is different to what gets run when the package is pulled/installed?

I am thinking that i might need to npm link, then just include explicitly the .ts file from node_modules and make an exception on that to have it run the custom code in the project. But this means that my project is build it rather than this project. Which isnt ideal.

Im interested on the flows that people use, and any info added to the readme would be great!

[tonypee]

@bkbooth @chetankothari - do you guys have any input on your process for creating/testing a pr?

[chetankothari]

@tonypee, since this project was a simple one I just copied over the code to the project where I was planning to use this package. Another approach I follow at times is to publish the package to a local instance of verdaccio and use it. Verdaccio is relatively very easy to setup.

Adding some info to the README sounds like a useful idea.