Hello, and welcome to the app! This is a hobby project and I'm still figuring out how to best code well with others. So if you have any questions / comments / concerns feel free to reach out to me. You are welcome to help out however you wish.
- Have both
nodeandyarninstalled. You can use npm instead of yarn of course but I'll pretend you're using yarn. - Make sure you have Factorio installed (app currently isn't smart enough to work without it)
- Fork the repository and get it on your computer however you wish
- Run
yarn installwhile in the repository to initialize the project - Run
yarn run devoryarn run debugto start the app. If using debug mode, you can open a web browser onhttp://localhost:9223to access the dev inspector for the app
- All work is based on develop, master branch is reserved for code that is ready to have a release made
- If you want to make changes based on something that already exists in issues, please leave a comment on that issue to avoid potential duplicate work. If you don't see an issue that matches what you work on, please create one and I'll get things sorted.
- Create a new branch with your work on it, based on develop or another sub branch of your choice
- Please make sure your code is linted (I'm using Standard.js and Vue rules).
If your code editor is configured for it, linting will be done automatically, otherwise you can runyarn run lintto check your code oryarn run lint:fixto let lint try to automatically fix errors - To test your code, you can run the commands
yarn run testoryarn test:coverage. Using the coverage option will generate a coverage report that can be viewed by opening theindex.htmlfile in a browser, found attest/unit/coverage/lcov-report- All tests go in the
test/unit/specsfolder. My plan is not to do e2e testing but unit test library functions that will be used in the renderer or main process
- All tests go in the