odoo-ide / pycharm-odoo-old

PyCharm plugin for Odoo

Home Page:https://plugins.jetbrains.com/plugin/13499-odoo

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Feature request] Wiki for starting to contribute

kevinkhao opened this issue · comments

Hello,

I think I'm not alone when I say, some of us come from other development environments. Personally, I am more used to straight text editors, so your plugin is very impressive.

So with all the functionality in this plugin, there are resources and PyCharm plugin development, but the road is very long and arduous when we don't have a background in IntelliJ OR we don't have any experience in your plugin.

It would help a lot if you can write in the wiki, even just a little bit, about:

  • a general overview of the structure of the plugin
  • how things are connected, for example which are the most important classes or what classes do the completion of classes in Python, how the plugin verifies the field exists in XML, how the plugin knows which field is available in a class
  • how the stubs are used

I think this will help users save a lot of hours stumbling around details that are not relevant to our goals (which is just to understand and contribute to pycharm-odoo)

Thanks for the plugin.

@kevinkhao Thank you!. I also want to write more documentation for this project. Hope I can find more time to do it.