When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.
After cloning the project run: npm install.
After that run npm run buildto packages.
To make sure your changes do not break any unit tests, run the following:
npm run testTo make sure your changes do not break any sandbox tests, run the following:
npm run sandbox.testAt the moment, operation in the Windows development environment is not guaranteed. We welcome contributions anytime.
Please follow the following guidelines:
- Use your OneSignalID and make sure you can web push and unsubscribe without problems in the
npm startenvironment. - Make sure unit tests pass
- Make sure sandbox tests pass
- Make sure
npm run lintpass - Make sure you run
npm format - Update your commit message to follow the guidelines below
Comment according to Conventional Commits.
The type must be one of the following:
- build - build
- ci - CI related
- feat - new feature
- fix - bug fix
- refactor - code refactoring
- release - release commit. Must only include version changes
- style - code style
- docs - documentation
- test - testing
- chore - othenrs category
The scope must be one of the following:
- ngx-onesignal - modification or additional to ngx-onesignal feature
- sandbox - involved in sandbox testing
The subject must contain a description of the change.