Skip to content

Commit a6e11c9

Browse files
authored
Merge pull request #237 from Xpirix/improve_publishing_docs
Improve documentation clarity in plugin publishing guidelines
2 parents b95c558 + 7b82c1f commit a6e11c9

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

qgis-app/templates/flatpages/docs_publish.html

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,15 @@ <h4>Requirements</h4>
1919
<ul>
2020
<li>Plugins need to have at least minimal documentation</li>
2121
<li>
22-
The plugin metadata contains a valid link to the homepage, the repository
23-
(source code), the tracker (issue tracker) and a license
22+
The plugin metadata contains a valid link to the homepage
23+
(the URL should either point to a page describing plugin
24+
usage or the README/wiki in your repository),
25+
the repository (source code - should be publicly accessible
26+
and should not contain zipped files),
27+
the tracker (issue tracker) and a license.
28+
</li>
29+
<li>
30+
All plugins should include a short English description of what the plugin does.
2431
</li>
2532
<li>
2633
The plugin license is compatible with the
@@ -39,7 +46,7 @@ <h4>Requirements</h4>
3946
<li>
4047
If the plugin has an external dependency, this needs to be clearly stated
4148
in the About metadata field; you can include a short guide to install
42-
Python libs as needed, or opint to existing guides, e.g. for Windows:
49+
Python libs as needed, or point to existing guides, e.g. for Windows:
4350
"<a href="https://landscapearchaeology.org/2018/installing-python-packages-in-qgis-3-for-windows/"
4451
>Installing Python packages in QGIS 3 (for Windows)</a>"
4552
</li>
@@ -61,7 +68,7 @@ <h4>Recommendations</h4>
6168
functionality and explore collaboration possibilities
6269
</li>
6370
<li>
64-
Make your plugin work on all supported platforms (Windows, Linux, macOs)
71+
Make your plugin work on all supported platforms (Windows, Linux, macOS)
6572
</li>
6673
<li>
6774
Don't rename the plugin title just because it's upgraded to a newer

0 commit comments

Comments
 (0)