Patchwork Contribution Guidelines
Maintained by @mmckegg
You can run
npm test or
npx standard to run the linter. A lot of small issues can be automatically fixed using
npx standard --fix.
depject inside of the Patchwork repo, but please don't merge in depject modules from other packages.Feel free to use
I recommend doing as much as possible in the Patchwork repo rather than splitting into a bunch of modules. This makes it much easier to maintain and update the overall application. Only split things into modules that are clearly reusable components (algorithms, widgets, indexes) and use
require to include them.
Originally depject was included in Patchwork to ease plugin creation, but I have realised since that this was not the best approach. When used across packages, it tends to create confusing hard to maintain APIs.
Please consider depject deprecated in Patchwork! It will be replaced with something else in the near future, and I want to keep as much of it contained in the main patchwork repo to assist with migration.