This guide is for everyone who want's to contribute to the development of NodeGui.

Please make sure you have read the User's guides before reading this guide.

• Setting up the NodeGui Contributor's Environment
  • Setting up macOS
  • Setting up Windows
  • Setting up Linux
• Getting started
  • Code Structure
  • Wrapping a widget: TLDR version
  • Learning Materials
• Styling
  • Painting
  • Layout
• Signal and Event Handling
• Debugging
• Common Errors
• Wrapping a Widget: Detailed

You can follow the contributors guide above to get a gist.

It is fairly straightforward to get started. I would start with a project of my own and start adding missing functionalities.

Or simply put I would recommend you start by adding an unexported method to an existing widget.

For example:

You could add the corresponding Qt method to QProgressbar https://doc.qt.io/qt-5/qprogressbar.html#textVisible-prop to get a grip on it.

This PR can be used as a guide

#36

#39

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.

https://github.com/nodegui/nodegui/projects/

https://github.com/nodegui/react-nodegui/projects/