17 lines
2 KiB
JavaScript
17 lines
2 KiB
JavaScript
import{j as e}from"./index-bIIEL2MP.js";import{useMDXComponents as r}from"./index-CO-0pc0F.js";import{M as s}from"./index-Z-6k0Xrj.js";import{p as i}from"./docsPage-CT2vyZOj.js";import"./_commonjsHelpers-D6-XlEtG.js";import"./iframe-CzjIX-qr.js";import"./index-aQYXhgXp.js";import"./index-DrFu-skq.js";function t(o){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",...r(),...o.components};return e.jsxs(e.Fragment,{children:[e.jsx(s,{title:"Contributing/Quickstart",parameters:{...i}}),`
|
|
`,e.jsx(n.h1,{id:"contributing",children:"Contributing"}),`
|
|
`,e.jsx(n.p,{children:"Reuters Graphics team members can contribute new components, and we welcome pull requests for any of our existing components from the community."}),`
|
|
`,e.jsxs(n.p,{children:["Components are documented (and tested) using ",e.jsx(n.a,{href:"https://storybook.js.org",rel:"nofollow",children:"Storybook"}),"."]}),`
|
|
`,e.jsx(n.h2,{id:"adding-a-new-chart-component",children:"Adding a new chart component"}),`
|
|
`,e.jsx(n.h3,{id:"prereqs",children:"Prereqs"}),`
|
|
`,e.jsxs(n.p,{children:["Before you start, it's probably a good idea to read up a bit on ",e.jsx(n.a,{href:"https://storybook.js.org/docs/svelte/get-started/introduction",rel:"nofollow",children:"Storybook"}),", the framework used to document components."]}),`
|
|
`,e.jsx(n.h3,{id:"quickstart",children:"Quickstart"}),`
|
|
`,e.jsx(n.p,{children:"Make a new git branch for your new component, like..."}),`
|
|
`,e.jsx(n.pre,{children:e.jsx(n.code,{children:`git checkout -b my-component
|
|
`})}),`
|
|
`,e.jsx(n.p,{children:"To start developing your component, start the dev server with..."}),`
|
|
`,e.jsx(n.pre,{children:e.jsx(n.code,{children:`pnpm start
|
|
`})}),`
|
|
`,e.jsx(n.p,{children:"When you're ready to share your component, commit your branch to GitHub, make a PR and we'll get it published!"}),`
|
|
`,e.jsx(n.pre,{children:e.jsx(n.code,{children:`git push origin my-component
|
|
`})})]})}function x(o={}){const{wrapper:n}={...r(),...o.components};return n?e.jsx(n,{...o,children:e.jsx(t,{...o})}):t(o)}export{x as default};
|