numberq
/
foundry
1
0
Fork 0
Code Releases 1 Activity
All user data for FoundryVTT. Includes worlds, systems, modules, and any asset in the "foundryuserdata" directory. Does NOT include the FoundryVTT installation itself.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
22 Commits
1 Branch
1.7 GiB
Tree: 3231847b45
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '3231847b45'
${ noResults }
foundry/Data/modules/lib-wrapper/CONTRIBUTING.md

48 lines
3.0 KiB
Raw Normal View History

Initial commit
1 year ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. # 1. Contributing to libWrapper

  2. 

  3. - [1. Contributing to libWrapper](#1-contributing-to-libwrapper)
  4.   - [1.1. Installation](#11-installation)
  5.   - [1.2. Test Suite](#12-test-suite)
  6.   - [1.3. Generating a Release Artifact](#13-generating-a-release-artifact)
  7.   - [1.4. Pull Requests](#14-pull-requests)
  8. 

  9. ## 1.1. Installation

  10. You should clone this repository and symlink it inside Foundry VTT's `Data/modules` folder, then restart the server.
  11. 

  12. -   After cloning this repository, you will need to install NPM and then run the following console commands to set up the development environment:
  13. 

  14.     ```bash
  15.     npm install
  16.     npm run build
  17.     ```
  18. 

  19.     These will install the NPM dependencies required for module development, and compile [less/lib-wrapper.less](less/lib-wrapper.less) into `dist/lib-wrapper.css`.
  20. 

  21. 

  22. ## 1.2. Test Suite

  23. The script contains a basic test suite in [tests](tests) which can be used to validate various usage cases and library behaviour. This can be run by doing `npm test`.
  24. 

  25. -   ⚠ While this test suite does test a significant amount of the library functionality, it does not achieve full coverage. It is always recommended to test the library with some real-world modules and confirm that they are working as expected.
  26. 

  27. -   The wiki list of [Modules using libWrapper](https://github.com/ruipin/fvtt-lib-wrapper/wiki/Modules-using-libWrapper) can be used as a source of modules for testing.
  28. 

  29. 

  30. ## 1.3. Generating a Release Artifact

  31. To generate a release artifact, you should use the command `npm run build`.
  32. 

  33. -   The JS code in [src](src) will be rolled up into a single file and minified automatically, with the corresponding sourcemap also generated. The results of this process are stored in `dist/lib-wrapper.js` and `dist/lib-wrapper.js.map`.
  34. 

  35.     -   For ease of development, by default the module manifest points to the unprocessed [src/index.js](src/index.js) such that source code changes are immediately visible.
  36. 

  37.     -   To use the output of the `npm run build` command, you will need to locally update your local [module.json](module.json) to point to `dist/lib-wrapper.js` instead of [src/index.js](src/index.js).
  38. 

  39. -   The LESS stylesheet [less/lib-wrapper.less](less/lib-wrapper.less) will be compiled into `dist/lib-wrapper.css`.
  40. 

  41. -   Note that the actual [release artifacts](https://github.com/ruipin/fvtt-lib-wrapper/releases) on Github are generated using a custom Github Action, which is responsible for updating the module manifest and packaging the build output into a ZIP file.
  42.     This is implemented in [.github/workflows/release.yml](.github/workflows/release.yml).
  43. 

  44. 

  45. ## 1.4. Pull Requests

  46. I am happy to receive pull requests and other contributions, although I might not have the time to look at them immediately.
  47. Before submitting a pull request, please ensure the test suite passes. It is also a good idea to open an issue in the issue tracker before doing any work, and discuss your plans.
  48. 

  49. The issue tracker will contain various feature requests, and contributions for those is particularly welcome.