1 line
7.3 KiB
JavaScript
1 line
7.3 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{468:function(e,t,n){"use strict";n.d(t,"a",(function(){return u})),n.d(t,"b",(function(){return m}));var r=n(0),a=n.n(r);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function c(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function b(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=a.a.createContext({}),l=function(e){var t=a.a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):c(c({},t),e)),n},u=function(e){var t=l(e.components);return a.a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},d=a.a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,i=e.parentName,p=b(e,["components","mdxType","originalType","parentName"]),u=l(n),d=r,m=u["".concat(i,".").concat(d)]||u[d]||s[d]||o;return n?a.a.createElement(m,c(c({ref:t},p),{},{components:n})):a.a.createElement(m,c({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=d;var c={};for(var b in t)hasOwnProperty.call(t,b)&&(c[b]=t[b]);c.originalType=e,c.mdxType="string"==typeof e?e:r,i[1]=c;for(var p=2;p<o;p++)i[p]=n[p];return a.a.createElement.apply(null,i)}return a.a.createElement.apply(null,n)}d.displayName="MDXCreateElement"},96:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return i})),n.d(t,"metadata",(function(){return c})),n.d(t,"rightToc",(function(){return b})),n.d(t,"default",(function(){return l}));var r=n(2),a=n(6),o=(n(0),n(468)),i={},c={unversionedId:"development/README",id:"development/README",isDocsHomePage:!1,title:"README",description:"Contributor's guide",source:"@site/docs/development/README.md",slug:"/development/README",permalink:"/docs/development/README",editUrl:"https://github.com/nodegui/nodegui/edit/master/website/docs/development/README.md",version:"current"},b=[],p={rightToc:b};function l(e){var t=e.components,n=Object(a.a)(e,["components"]);return Object(o.b)("wrapper",Object(r.a)({},p,n,{components:t,mdxType:"MDXLayout"}),Object(o.b)("h1",{id:"contributors-guide"},"Contributor's guide"),Object(o.b)("p",null,"This guide is for everyone who want's to contribute to the development of NodeGui."),Object(o.b)("p",null,"Please make sure you have read the ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"/"}),"User's guides")," before reading this guide."),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/setting-up"}),"Setting up the NodeGui Contributor's Environment"),Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/setting-up#macosx"}),"Setting up macOS")),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/setting-up#windows"}),"Setting up Windows")),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/setting-up#linux"}),"Setting up Linux")))),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/getting-started"}),"Getting started"),Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/getting-started#Code-Structure"}),"Code Structure")),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/getting-started#Wrapping-a-widget"}),"Wrapping a widget: TLDR version")),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/getting-started#Learning-Materials"}),"Learning Materials")))),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/styling"}),"Styling"),Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/styling#painting"}),"Painting")),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/styling#layout"}),"Layout")))),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/signal_and_event_handling"}),"Signal and Event Handling")),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/debugging"}),"Debugging")),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/common_errors"}),"Common Errors")),Object(o.b)("li",{parentName:"ul"},Object(o.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/development/wrapping_widgets"}),"Wrapping a Widget: Detailed"))),Object(o.b)("h1",{id:"where-to-start-or-how-can-you-help"},"Where to start or How can you help?"),Object(o.b)("p",null," You can follow the contributors guide above to get a gist."),Object(o.b)("p",null," It is fairly straightforward to get started. I would start with a project of my own and start adding missing functionalities."),Object(o.b)("p",null," Or simply put I would recommend you start by adding an unexported method to an existing widget."),Object(o.b)("p",null," ",Object(o.b)("strong",{parentName:"p"},"For example:")),Object(o.b)("p",null," You could add the corresponding Qt method to QProgressbar\n",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://doc.qt.io/qt-5/qprogressbar.html#textVisible-prop"}),"https://doc.qt.io/qt-5/qprogressbar.html#textVisible-prop")," to get a grip on it."),Object(o.b)("p",null," This PR can be used as a guide"),Object(o.b)("p",null," ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/nodegui/nodegui/issues/36"}),"https://github.com/nodegui/nodegui/issues/36")),Object(o.b)("p",null," ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/nodegui/nodegui/pull/39"}),"https://github.com/nodegui/nodegui/pull/39")),Object(o.b)("p",null," You can also take a look at few bugs or the issue board here to know what you can pick up if you are out of ideas."),Object(o.b)("p",null," ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/nodegui/nodegui/projects/"}),"https://github.com/nodegui/nodegui/projects/")),Object(o.b)("p",null," ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/nodegui/react-nodegui/projects/"}),"https://github.com/nodegui/react-nodegui/projects/")))}l.isMDXComponent=!0}}]); |