Welcome to the contribution guidelines for Project FU! We appreciate your interest in improving our system. Please follow the guidelines below for code and content contributions.
If you have any questions or concerns, feel free to reach out to us through the following channels:
- Discord: Rooster Games Discord -
#bot-and-tool-discussionchannel - Discord: Project FU Discord -
#supportchannel
Issues reported on GitHub and support channels will be reviewed and tracked on our Trello Board. Please follow the guidelines below for different types of issues.
Before submitting a bug report, ensure the following:
- Bugs are reproducible without active modules. If module-related, contact the module author.
- Provide relevant hosting details.
- Include clear instructions on reproducing the issue and the expected vs actual outcome.
Project FU is based on the Boilerplate Template, using plain JavaScript and Gulp for build tasks. Future plans include incorporating new frameworks such as Tailwind/PostCSS, migrating to Vite as the default bundler.
- main: Mainline branch for v11 releases and above.
- dev: Primary development branch.
When opening a PR, ensure it goes into the dev branch.
- Git
- Node.js LTS
- Code editor (recommended: Visual Studio Code)
Clone the repository and run:
npm installStart the build process in watch mode:
npm run watchOr for a one-time build:
npm run buildEnable the Hot-Reload Package Files option in your Foundry application configuration for an improved developer experience.
To contribute code, fork the repository and submit a pull request.