qgis / QGIS-Processing

Example scripts, algorithms etc
98 stars 86 forks source link

Documentation for submission process? #80

Open Crghilardi opened 6 years ago

Crghilardi commented 6 years ago

I have a script I would like to contribute to this repo and I wanted to just clear up some questions here that I think could be valuable for other people so I wanted to document it as an issue.

Question 1. I have never come across the py.help files before, are those generated somehow by the helper scripts in the base folder or should I just copy and paste one and change in a text editor?

Question 2. I was not sure what to with the help_converter.py and create_lists.py scripts. As far as I understand, the process should go roughly:

  1. Fork repo
  2. Add script to respective language folder
  3. Run help_converter.py and create_lists.py
  4. Submit pull request

Is this correct or am I missing something?

I would be glad to type something up that can be added to the Readme.md or something once I figure out how this process goes.