Skip to content
This repository was archived by the owner on Jul 11, 2022. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (24 loc) · 838 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 838 Bytes

Contributing to Hawk Eye

Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations.

Development setup

  • Fork the Hawk Eye repository in to your own account, and clone to your device.
  • Install the project dependencies.
$ npm install
  • Install typing definitions.
$ typings Install
  • You'll need to setup an OAuth GitHub app and add your configuration file under src/js/Config/HawkEye.ts. Follow the HawkEye.default.ts file for more information.
  • Make your changes and build, then run the app.
$ gulp
$ electron .
  • You can package the app using, and run from the dist folder.
$ npm run pack
  • Confirm your changes work, and create a Pull Request to the Hawk Eye repository.