react-okr-ui/docs/component---src-docs-contribution-mdx-0c7c129232efcbb89c0f.js

A React user interface toolkit for building OKR centric applications.

(window.webpackJsonp=window.webpackJsonp||[]).push([[6],{yVX9:function(e,t,n){"use strict";n.r(t),n.d(t,"_frontmatter",(function(){return c})),n.d(t,"default",(function(){return u}));var i=n("Fcif"),o=n("+I+c"),r=(n("mXGw"),n("/FXl")),b=n("TjRS"),c=(n("aD51"),{});void 0!==c&&c&&c===Object(c)&&Object.isExtensible(c)&&!c.hasOwnProperty("__filemeta")&&Object.defineProperty(c,"__filemeta",{configurable:!0,value:{name:"_frontmatter",filename:"src/docs/contribution.mdx"}});var l={_frontmatter:c},a=b.a;function u(e){var t=e.components,n=Object(o.a)(e,["components"]);return Object(r.b)(a,Object(i.a)({},l,n,{components:t,mdxType:"MDXLayout"}),Object(r.b)("h1",{id:"contribution-guide"},"Contribution guide"),Object(r.b)("h2",{id:"git"},"Git"),Object(r.b)("p",null,"Contributors should work from the latest version branch in development (indicated using format ",Object(r.b)("inlineCode",{parentName:"p"},"v0.1.0"),")."),Object(r.b)("p",null,"Pull requests will be reviewed for contribution to future releases."),Object(r.b)("h2",{id:"development"},"Development"),Object(r.b)("p",null,"The easiest way to get started is via the included Docz site. Docz is a React based static site generator for documentation. It uses mdx."),Object(r.b)("p",null,"Using Docz we have components in a living style guide. To run Docz locally for development:"),Object(r.b)("pre",null,Object(r.b)("code",{parentName:"pre"},"npm install\nnpm run docz:dev\n")),Object(r.b)("p",null,"To run a build of the Docz site:"),Object(r.b)("pre",null,Object(r.b)("code",{parentName:"pre"},"npm run docz:build\n")),Object(r.b)("p",null,"To build and serve a Docz site:"),Object(r.b)("pre",null,Object(r.b)("code",{parentName:"pre"},"npm run docz:serve\n")),Object(r.b)("h2",{id:"build"},"Build"),Object(r.b)("p",null,"Builds for distribution are via Webpack. To test your builds, you can:"),Object(r.b)("pre",null,Object(r.b)("code",{parentName:"pre"},"npm run build\n")),Object(r.b)("p",null,"Builds are distributed via npm."))}void 0!==u&&u&&u===Object(u)&&Object.isExtensible(u)&&!u.hasOwnProperty("__filemeta")&&Object.defineProperty(u,"__filemeta",{configurable:!0,value:{name:"MDXContent",filename:"src/docs/contribution.mdx"}}),u.isMDXComponent=!0}}]);
//# sourceMappingURL=component---src-docs-contribution-mdx-0c7c129232efcbb89c0f.js.map