Welcome 🎉!! If you've found a bug, or have an idea to add a feature we'd love to hear from you. It may save time to first ping the group on Partytown's Discord channel to talk through any ideas or any issues that may be a bug.
npm install
npm run dev
See the distribution section about the various files created. Note that both the root directory, and the tests directory receive a copy of the build files, such as tests/~partytown/partytown.js.
We need your help! If you found a bug, it's best to create a Pull Request that replicates the issue using a test page.
- Minimal Reproduction Case: If maintainers and contributors are unable to reproduce the same error, then it makes it very difficult to debug and fix. Any issued opened without a minimal reproduction example will be closed.
- E2E Test: A good example of an End-to-end test is one where the test fails before the fix, and passes after the fix. But also, all the other tests pass too.
In the tests directory, copy one of the directories, such as tests/platform/document, and recreate the issue you've found.
Follow the manual testing directions on how to start the local dev server. Next, the more you can describe the debug and pin-point the issue the better, and any fixes to the runtime to solve the problem would be awesome. 🎉
If the PR fixes the issue, then creating an end-to-end test would help ensure no regressions happen over time.
Additionally, Github issues is a place to explain a problem in detail, along with a reproduction case for maintainers. However, Github issues is not the best place to ask how-to questions since project contributors and maintainers don’t have the capacity to debug external websites and the many third-party scripts. Any issues opened asking that are not following these guidelines will be closed.
Please also see the FAQ section for more info
If you are the author / developer of any 3rd party plugin / library, and want to ensure that your library works with Partytown, we would love to work with you to ensure it does!
The easiest way to verify is to create a small, standalone replica in our integration tests directory. Our standard practice is to:
- Create a
standard.htmlwhich loads your library / plugin as it normally is loaded, as a<script type="text/javascript">. This file basically is your normal, happy case, with no Partytown in sight. - Create an
index.htmlwhich loads your library, but also sets up Partytown. This file should:- Setup the
partytownconfiguration - Load the
partytown.jsfile - Mark the library / plugin that you want to test as
text/partytowninstead oftext/javascript
- Setup the
To get a sense of this, you can take a look at some examples in the tests/integrations folder like Twitter. Usually, creating a copy of one of these folders and modifying it for a new plugin is the easiest way to get these to setup.
If it works, great! Send us a PR and we'd love to merge it in and highlight it as a working integration on our Common Services page . If for any reason it does not work, we would love to help you figure out why it might not be working and figure out a way forward.
Tests to be manually ran on a browser are located in the tests directory. These pages can help to test out DOM apis and individual services.
npm run serve
E2E tests use @playwright/test, which allows us to test on Chromium, Firefox and WebKit browsers. These pages are also tested on every commit within the project's CI Workflow.
npm test
The same pages found in tests are deployed to:
npm run release