Skip to content

Latest commit

 

History

History
22 lines (19 loc) · 967 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (19 loc) · 967 Bytes

Contributing

How to Contribute

  • fork the nx-electron package from github:
    • git clone https://github.com/bennymeg/nx-electron.git
  • link the forked project:
    • cd nx-electron && npm link
  • make your desired changes to your fork of the nx-electron repository
  • create a new test project and link your forked project into it:
    • npx create-nx-workspace nx-electron-test
    • cd nx-electron-test && npm link nx-electron
    • nx g nx-electron:app <electron-test-app-name> --frontendProject=<frontend-test-app-name>
    • test your changes (e.g. serving, building, packaging, making, etc..)
  • test the forked project and make sure it completes without any warnings
    • npm run test
  • lint the forked project and make sure it completes without any warnings
    • npm run lint
  • open a pull request