factorio-blueprint-editor/CONTRIBUTING.md

Contributing

First of all, thanks for your interest in helping out! 😃

Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible and a minimal reproduction scenario allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.

You can file new issues by selecting from our new issue templates and filling out the issue template.

Submitting a Pull Request

Prerequisites

• git
• yarn
• node
• vscode
• rust
• systemfd
• cargo-watch

Note

This project uses eslint and prettier to lint and format code. I would recommend that you use vscode for this project because the repo already contains the extension settings for autofixing linting errors and formatting code on save. So, make sure to download the recommended workspace extensions in vscode after cloning the repo.

Steps

1. Fork the repo
2. Clone your fork
3. Download the recommended workspace extensions in vscode
4. Create a new git branch (git checkout -b my-fix-branch master)
5. Create a new file at the path packages/exporter/.env and add your FACTORIO_USERNAME and FACTORIO_TOKEN (you can get those here)
6. Run yarn
7. Run yarn start:website and yarn start:exporter
8. Open the link in a browser or use the vscode debugger
9. Make changes
10. Commit your changes using a descriptive commit message
11. Push your branch to GitHub git push origin my-fix-branch
12. Start a pull request from GitHub

That's it! 🎉 Thank you for your contribution! 😃

Working on your first Pull Request?

Check out this tutorial

Also, How to Contribute to an Open Source Project on GitHub for a more in depth (video) tutorial