Contributing guidelines not clear about how to debug your changes locally

Version and environment information:

1. Newman Version (can be found via newman -v): 4.5.7
2. OS details (type, version, and architecture): GNU/Linux - Fedora 29
3. Are you using Newman as a library, or via the CLI? N/A
4. Did you encounter this recently, or has this bug always been there: N/A
5. Expected behaviour: N/A
6. Command / script used to run Newman: newman run
7. Sample collection, and auxiliary files (minus the sensitive details): N/A
8. Screenshots (if applicable): N/A

The contributing documentation is not clear about how to run newman locally and debug your changes(after step 6 from below), which makes it tricky for developers getting started. I’d like to add that information to the contributing docs.

1. Clone this repository / your fork of this repository using `git`
2. If not on `develop`, switch to the `develop` branch with `git checkout develop`
3. Run `npm install` in the project directory
4. Make sure everything is working by running `npm test`.
5. Create a new feature branch from `develop` with `feature/your-feature-name`.
6. Make the necessary changes in line with the objective(s) of the pull request
7. Ensure that you have added unit and integration tests for any new features added / bugs fixed
8. Run `npm test`. If any tests fail, resolve the issue with the code, and re-try
9. Once the tests pass, commit and push. **Do not** alter the `version` in `package.json`
10. Create a pull request to `develop`

[jimc404]

Maybe I’m missing the point here but isn’t running npm link enough to locally debug nodejs packages. It’ll create the needed symlinks to usr/lib/node_modules/ so we can then use it as a regular package.

Although the other mentioned points can definitely help beginners with starting their contributions.

Edit: I was talking in reference to the linked PR and commented on the wrong page. npm link is pretty standard for developing packages so it’ll be better to just mention that in CONTRIBUTING.md

[aquibbaig]

@shamasis Yes, the contributing guidelines can be updated to reflect this too. It’s hard to implement those things in Newman which are not clearly thought of in Postman itself. @codenirvana What do you think?