<div dir="ltr"><div><div>Dear users and contributors,</div><div><br></div><div>I've created an example project (repository) on <span class="gmail-il">GitHub</span>. It is a GRASS GIS module written in Python which simply adds two raster maps together. It uses <span class="gmail-il">GitHub</span> Actions to build the module and publish its documentation as a website (using GitHub Pages).<br></div></div><div><br></div><div><div></div><div><a href="https://github.com/wenzeslaus/r.example.plus">https://github.com/wenzeslaus/r.example.plus</a></div></div><div><br></div><div>This is based on my earlier work on an example project on GitLab [1] and includes several improvements and changes:</div><div><br></div><div>* There is a test suite included with couple of test functions.</div><div></div><div>* It uses Black for code formatting (assuming author runs it manually).</div><div>* Repository is marked as a template (see the big "Use this template" button).<br></div><div>* GitHub Actions are used for:</div><div> * compiling the module and running tests,</div><div> * checking code quality with Flake8 and Pylint, and</div><div> * checking code style with Black.</div><div>* GitHub Actions are now used for publishing documentation (done by GitLab CI before).</div><div>* Option names now follow GRASS GIS standards more.<br></div><div>* More documentation in the code and on how to use the code.</div><div>* Badges are now in the README file (GitLab had those as project properties).<br></div><div><br></div><div><div>Otherwise,
I hope the project should describe itself and if something is missing
or is not documented enough, please open an issue or a pull
request.</div><div><br></div><div>Best,</div><div>Vaclav</div><div><br></div><div></div><div>PS: We can discuss on grass-dev if this should go under some organization and how to improve the "what's next" part [2].</div><div><br></div><div>[1] <a href="https://lists.osgeo.org/pipermail/grass-dev/2018-November/090438.html">https://lists.osgeo.org/pipermail/grass-dev/2018-November/090438.html</a></div><div>[2] <a href="https://github.com/wenzeslaus/r.example.plus#what-is-next">https://github.com/wenzeslaus/r.example.plus#what-is-next</a></div><div><br></div></div></div>