Code contributions are accepted. Please feel free to submit issues to the issue tracker or submit pull requests for code changes. Approval for such requests involves code and (if necessary) design review by the Maintainer(s) of this repo. Please reach out on the Tidy 5e Sheets discord server with any questions.
Please ensure that there is an open issue about whatever contribution you are submitting. Please also ensure your contribution does not duplicate an existing one.
Tidy 5e Sheets builds a rich UI with svelte and leverages vite to provide a rapid feedback development experience with hot module replacement (HMR). When set up properly, the developer tooling can live-update the browser when component and SCSS changes occur.
- Node.js LTS version
- (Recommended) A code editor, such as the free VS Code
- Download the repo
- Run
npm install - Run
npm run prepare-dev - Copy
foundry-data-path-config_example.jsontofoundry-data-path-config.json - Edit
foundry-data-path-config.jsonand changedataPathto point to your Foundry VTT data folder (the folder that contains the subfoldersConfig,Data, andLogs) - Run
npm run link-createto create a symlink from the newly-createddistfolder to the Foundrymodulesfolder astidy5e-sheet - Run
npm run dev - Start Foundry VTT
Installs all dependencies needed to run developer tooling scripts and to build the module.
Runs Tidy 5e Sheets in dev mode with HMR enabled.
Important Dev mode runs on
http://localhost:30001. Dev mode will not run on port30000.
Builds a production distribution of the module.
Symlinks the build folder to the Foundry VTT data folder defined in foundry-data-path-config.json.
Removes the symlink from the build folder to the Foundry VTT data folder.
There are other scripts that are used for a variety of tasks outside the scope of contributing code. These scripts are subject to change moreso than those listed above.
Check that your Issue isn't a duplicate (also check the closed issues, as sometimes work which has not been released closes an issue).
Use the "Bug report" template.
- Ensure that the bug is reproducible with no other modules active. If the bug only happens when another module is active, see the section on Module Compatibility.
- Provide clear step-by-step reproduction instructions, as well as what you expected to happen during those steps vs what actually happened.
Note
An issue template is in the works. It's not ready yet.
Use the "Feature request" template.
Any feature request should be considered from the lens of "Is this in the scope of a sheets module?"
- This is a sheets module with the aim of providing a clean UI and a convenient user experience when running and playing D&D 5e. There are innumerable ways the sheets could be expanded and upgraded, but the central goal is to make sheets that improve the experience for the most users possible without making the code base unmaintainable or the management of the sheets too complex in the UI.
- If the intended feature is more specialized or specific than what one would expect in the core sheets, consider making a module that extends Tidy 5e sheets through the API.
- Any feature addition should begin with a github issue and discussion with the maintainer and community. Surprise PRs with sweeping changes may be rejected.
Note
An issue template is in the works. It's not ready yet.
Important Tidy 5e Sheets will not automatically work with sheet-augmenting modules which target the default 5e sheets. Tidy 5e Sheets deviates from the HTML structure of the default sheets in a variety of ways and is subject to change over time as the layouts are updated and new layouts are created.
Within reason, the Maintainer(s) of this repository can make changes to improve compatibility, but in many cases, it will be up to the module developer to utilize the provided Tidy 5e Sheets API to augment the sheets in a supported way. If it is deemed beyond the threshold of simple adjustments which make sense for these sheets, report it to that module's author and request they use the API.
Use the "API Request" template.
If there is missing API functionality, the Maintainer(s) of this module will make efforts to provide the missing functionality in a general way that will work for other module developers as well.
Note
An issue template is in the works. It's not ready yet.
PRs are welcome for localization to other languages. Currently, Tidy 5e Sheets keeps all translation files within this repository in the lang directory.
Here are some guidelines for contributing code to this project.
To contribute code, fork this project and submit a pull request (PR) against the main branch.
The Maintainer(s) of this module intend to support it for as long as possible. As such, we request that code submissions attempt to use a coding style that is similar to what is in the repository. For formatting, we recommend using "prettier," which has extensions in popular code editors.
The Maintainer(s) reserve the right to refactor code if it helps in maintaining it. This is not to say the Maintainer(s)' style is more correct; it is simply a matter of personal preference, because when the code goes into main, we become the caretakers.
Before (or alongside) submitting an PR, we ask that you open a feature request issue. This will let the Maintainer(s) discuss the approach and prioritization of the proposed change.
If you want to work on an existing issue, leave a comment saying you're going to work on the issue so that other contributors know not to duplicate work. Similarly, if you see an issue is assigned to someone, that member of the team has made it known they are working on it.
When you open an PR it is recommended to link it to an open issue. Include which issue it resolves by putting something like this in your title:
[#32] Resolves STR Check Click Bug
Review from the Maintainer(s). kgar has final review and is the only one with merge permission.
Tidy 5e Sheets is intended to be able to make numerous small releases, introducing new features and fixing bugs quickly. All changes merged to main since the last release are bundled into the release write-up.