Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
134 lines (98 loc) · 4.49 KB

CONTRIBUTING.md

File metadata and controls

134 lines (98 loc) · 4.49 KB

Contributing to iframe-resizer

Looking to contribute something? Here's how you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

Please do not use the issue tracker for personal support requests. These should be raised on Stack Overflow (iframe-resizer tag).

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

  1. Lint your code — Using npm run eslint:fix to ensure your problem isn't caused by a simple error in your own code.

  2. Use the GitHub issue search — check if the issue has already been reported.

  3. Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.

  4. Isolate the problem — ideally create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project.

Pull requests

Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features or refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

In lieu of a formal style-guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Testing

This project uses multiple testing approaches:

Unit Tests (Jest)

Unit tests are located in packages/*/ directories with .test.js extension.

npm run test:jest        # Run unit tests
npm run test:watch       # Run unit tests in watch mode

Integration Tests (Karma)

Legacy integration tests are in the spec/ directory using Karma + Jasmine.

npm run test:int         # Run integration tests (requires build first)
npm run test:int:watch   # Run integration tests in watch mode

E2E Tests (Playwright)

Modern end-to-end tests are in the e2e/ directory using Playwright. These tests run in real browsers and test actual iframe behavior.

First time setup:

npx playwright install chromium  # Install browser

Running tests:

npm run test:e2e         # Run all e2e tests
npm run test:e2e:headed  # Run tests with visible browser
npm run test:e2e:ui      # Run tests in interactive UI mode
npm run test:e2e:debug   # Run tests in debug mode

See e2e/README.md for more details on writing and running Playwright tests.

Full Test Suite

npm test                 # Run all tests (Jest + build + Karma)

Building

Before running integration or e2e tests, build the project:

npm run rollup:debug     # Build for development
npm run rollup:prod      # Build for production

License

By contributing your code, you agree to license your contribution under the MIT License.