mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2026-11-20 07:23:13 +09:00
Ports the clusterio versions of the changelog scripts. pr_to_changelog.mts gains the Contributors and Statistics blocks and a shared checkPullRequestBody, which check_pr_changelog.mts runs on every pull request through the new Changelog workflow. The latest release is now the newest one targeting main. Adds the pull request template the check expects, and node --test runs the script tests in Node.js CI. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1.5 KiB
1.5 KiB
Contributing
All are welcome to make bug reports, feature requests, and pull requests for our scenario. We do not require you to have any coding knowledge to make bug reports and feature requests. If you have any questions ask us in our discord.
For developers wanting to add features please follow these guidelines:
- All lua code is documented using ldoc.
- Set the
CLUSTERIOenvironment variable to your clusterio development install path, the lint needs it to resolvemodules/clusterio/*. - Lua is checked with emmylua, configured by
.emmyrc.json. Install the EmmyLua extension rather than sumnekolua / luals, and use factoriomod-debug to generate the factorio api types. Note that an inline cast must be written--[[@as T]], the spaced form is not parsed. - Changes should be made on your own fork and merged into
mainthrough a pull request. - Each pull request should be limited to one feature or a few bug fixes and link to the related issue page.
- Fill in the Changelog section of the pull request template, or replace its code block with
None.and a reason. A CI check validates it and the release notes are built from it. - Pull requests are automatically linted, then built and tested against the latest clusterio
master. - Pull requests are manually reviewed to maintain code and language quality.
- New features should have the branch names:
feature/feature-name - Bug fixes should have the branch names:
fix/bug-name - Commits should have meaningful messages.