History

Simon Edwards c733a41d10 Add design documentation for improved memory management		2022-04-28 11:43:27 +02:00
..
common_errors.md	Adds dynamic content support for flex layout. (#199 )	2019-11-18 00:52:29 +01:00
debugging.md	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
getting-started.md	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
README.md	Update README.md	2019-10-04 17:41:14 +02:00
setting-up.md	Adds readme for m1 macs (#849 )	2021-07-09 00:48:45 +02:00
signal_and_event_handling.md	Make the wrapper cache generic. Apply it to `QWindow` and `QScreen`	2021-10-31 09:32:37 +01:00
styling.md	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00
wrapper_cache.drawio.svg	Add design documentation for improved memory management	2022-04-28 11:43:27 +02:00
wrapper_caching.md	Add design documentation for improved memory management	2022-04-28 11:43:27 +02:00
wrapper_keep_alive_seq.png	Add design documentation for improved memory management	2022-04-28 11:43:27 +02:00
wrapper_keep_alive_seq.puml	Add design documentation for improved memory management	2022-04-28 11:43:27 +02:00
wrapping_widgets.md	Adds new doc site (#124 )	2019-09-29 20:14:35 +02:00

Contributor's guide

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.

Where to start or How can you help?

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

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.