[GRASS-user] Example project for a GRASS GIS module on GitHub

["Peter Löwe"]

Hi Vasek,

thanks for setting up the demo module on GitHub!

To demonstrate how module authors can get credit by scientific citation, some kind of reference/howto describing how the integration of the GitHub project and the Zenodo data repositiory (https://www.zenodo.org/) can be achieved, as explained here: https://www.zenodo.org/login/?next=%2Faccount%2Fsettings%2Fgithub%2F  https://guides.github.com/activities/citable-code/
By doing so, a persistent identifier (DOI) is assigned to the GRASS module codebase. Zenodo also offers a handy tool to provide citation strings for the modulde code in hundreds of citation styles.

Best regards,
Peter

<peter.loewe at gmx.de>

> From: grass-user <grass-user-bounces at lists.osgeo.org> On Behalf Of Vaclav Petras
> Sent: torsdag 30. januar 2020 02:31
> To: grass-dev at lists.osgeo.org; GRASS user list <grass-user at lists.osgeo.org>
> Subject: [GRASS-user] Example project for a GRASS GIS module on GitHub
>
> Dear users and contributors,
>
> I've created an example project (repository) on GitHub. It is a GRASS GIS module written in Python which simply adds two raster maps together. It uses GitHub Actions to build the module and publish its documentation as a website (using GitHub Pages).
>
> https://github.com/wenzeslaus/r.example.plus
>
> This is based on my earlier work on an example project on GitLab [1] and includes several improvements and changes:
>
> * There is a test suite included with couple of test functions.
> * It uses Black for code formatting (assuming author runs it manually).
> * Repository is marked as a template (see the big "Use this template" button).
> * GitHub Actions are used for:
>   * compiling the module and running tests,
>   * checking code quality with Flake8 and Pylint, and
>   * checking code style with Black.
> * GitHub Actions are now used for publishing documentation (done by GitLab CI before).
> * Option names now follow GRASS GIS standards more.
> * More documentation in the code and on how to use the code.
> * Badges are now in the README file (GitLab had those as project properties).
>
> 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.
>
> Best,
> Vaclav
>
> PS: We can discuss on grass-dev if this should go under some organization and how to improve the "what's next" part [2].
>
> [1] https://lists.osgeo.org/pipermail/grass-dev/2018-November/090438.html
> [2] https://github.com/wenzeslaus/r.example.plus#what-is-next