puppeteer/assets/js/ecfe08ed.ebba52af.js

1 line
26 KiB
JavaScript
Raw Normal View History

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[28382],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>d});var i=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?r(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,i,a=function(e,t){if(null==e)return{};var n,i,a={},r=Object.keys(e);for(i=0;i<r.length;i++)n=r[i],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i<r.length;i++)n=r[i],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=i.createContext({}),p=function(e){var t=i.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},u=function(e){var t=p(e.components);return i.createElement(s.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},c=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),c=p(n),d=a,h=c["".concat(s,".").concat(d)]||c[d]||m[d]||r;return n?i.createElement(h,o(o({ref:t},u),{},{components:n})):i.createElement(h,o({ref:t},u))}));function d(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,o=new Array(r);o[0]=c;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:a,o[1]=l;for(var p=2;p<r;p++)o[p]=n[p];return i.createElement.apply(null,o)}return i.createElement.apply(null,n)}c.displayName="MDXCreateElement"},22770:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>m,frontMatter:()=>r,metadata:()=>l,toc:()=>p});var i=n(87462),a=(n(67294),n(3905));const r={sidebar_position:4},o="Contributing",l={unversionedId:"contributing",id:"contributing",title:"Contributing",description:"First of all, thank you for your interest in Puppeteer!",source:"@site/../docs/contributing.md",sourceDirName:".",slug:"/contributing",permalink:"/contributing",draft:!1,tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4},sidebar:"sidebar",previous:{title:"Troubleshooting",permalink:"/troubleshooting"},next:{title:"Chromium Support",permalink:"/chromium-support"}},s={},p=[{value:"Contributor License Agreement",id:"contributor-license-agreement",level:2},{value:"Getting Code",id:"getting-code",level:2},{value:"Code reviews",id:"code-reviews",level:2},{value:"Code Style",id:"code-style",level:2},{value:"TypeScript guidelines",id:"typescript-guidelines",level:2},{value:"Project structure and TypeScript compilation",id:"project-structure-and-typescript-compilation",level:2},{value:"Shipping CJS and ESM bundles",id:"shipping-cjs-and-esm-bundles",level:3},{value:"tsconfig for the tests",id:"tsconfig-for-the-tests",level:3},{value:"Root <code>tsconfig.json</code>",id:"root-tsconfigjson",level:3},{value:"API guidelines",id:"api-guidelines",level:2},{value:"Commit Messages",id:"commit-messages",level:2},{value:"Writing Documentation",id:"writing-documentation",level:2},{value:"Writing TSDoc Comments",id:"writing-tsdoc-comments",level:2},{value:"Running New Documentation website locally",id:"running-new-documentation-website-locally",level:2},{value:"Adding New Dependencies",id:"adding-new-dependencies",level:2},{value:"Running &amp; Writing Tests",id:"running--writing-tests",level:2},{value:"Public API Coverage",id:"public-api-coverage",level:2},{value:"Debugging Pupp