Desktop-App-Helper

Contributing guide

1. Create feature branch and perform changes.
2. Push changes to the origin and create pull-request.
3. After pull-request merging update local master.
4. Bump version and add a tag (for example using npm version).
5. Build module npm run build.
6. Push changes to the origin.
7. Publish new version to NPM.

Versioning rules

• patch - new features and non-breaking fixes for existing ones. Does not require related projects updating
• minor - breaking changes that require related projects updating
• major - reserved for major updates

Testing in related projects

There is a way to test new version of desktop-app-helper without publishing it to NPM:

1. Execute npm link inside desktop-app-helper project root.
2. Execute npm link @macpaw/desktop-app-helper inside related project's root.
3. Rebuild related project if needed.

Scripts

• npm run lint - check code with eslint
• npm run build - it will generate lib dir with ES4 files