gap-packages/example

GAP Example Package

example's Issues

Use proper GitHub Actions concurrency

As in https://github.com/gap-system/gap/blob/master/.github/workflows/CI.yml, rather than trying to cancel PR builds on a pushed branch, as we do here currently...

example/.github/workflows/CI.yml

Lines 13 to 14 in 6ef2335

	# Don't run this twice on PRs for branches pushed to the same repository
	if: ${{ !(github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) }}

Complete HELLO_WORLD version as a kernel module

https://github.com/gap-packages/example/blob/master/src/hellod.c has a prototype of a HELLO_WORLD example implemented as a kernel module. It has to be checked, completed, added to the test and documented.

Future plans for the Example package

After gap-system/gap#484 has been merged, this package will not have guidelines. It will be a mock package which should demonstrate how to apply those guidelines. I think it should be made closer to look like what https://github.com/gap-system/PackageMaker would create, and it should demonstrate how to use Travis CI and CodeCov to run regression tests and get code coverage reports. That will increase its value, as it will demonstrate to PackageMaker users where to go from the stub package that PackageMaker will produce for them, and show to package authors how to set up CI and code coverage tools.

Document that it is allowed to have both author and maintainer as false

We now permit both of these to be false for contributors who are neither authors nor maintainers. This is useful to give credits to contributors who are in neither of the two categories. The comment should be updated to explain that.

example/PackageInfo.g

Lines 152 to 155 in e9593b0

	## # At least one of the following two entries must be given and set
	## # to 'true' (an entry can be left out if value is not 'true'):
	## IsAuthor := true;
	## IsMaintainer := true;

This shows that again we managed to change ValidatePackageInfo without updating the sample PackageInfo.g file :(

Move guidelines to the GAP reference manual

see gap-system/gap#484

Demonstrate how to use several tst files and TestDirectory

Move README to README.md

Convert the text to markdown so GitHub will render it automatically and nicer.

New website for the Example package

Just to declare my further plans: use https://github.com/fingolfin/PackageMaker by @fingolfin to have a GitHub pages based Example package's website.

Update recommendations about the test file

This comment should be updated:

example/PackageInfo.g

Line 394 in 60dd8d1

## *Optional*, but recommended: path relative to package root to a file which