U++ forum: Welcome to the forum

Re: New UppHub root [message #56144 is a reply to message #56142]

Sun, 31 January 2021 21:46

Klugier
Messages: 1085
Registered: September 2012
Location: Poland, Kraków

Senior Contributor

Hello Mirek,

Quote:

Well, the idea is

a) this README.md is not to be visited by users, so it does not really matter
b) you can edit it directly in github

The README.md can be visited by the user. If you found ultimatepp organization and then you are curious what is UppHub then you will see the list of the packages without any description. I think we need minimal README.md for UppHub repository. READSME.md file is all about communication with the visitor. If we push there dry data then the visitor will lose the learning opportunity. In our case README.md should contains description - what is UppHub and how can I add package to it, also adding links to our documentation would be valuable.

You can edit any file direcly on github not only README.md, so if you put upphub.json you can edit it too directly on GitHub (like any other text files). Please noticed that users outside organization will still needs to create PR for any modification. For us this is wanted behavior.

Quote:

Adding check to autotest...

Can you publish the results of automation somewhere. I think it would be nice if we have idea how stable upp is at the moment. Now you have this knowledge Smile

This check is indeed the step in the good direction, however if I modify (as a maintainer) the file and break the json the regression will be detected later. Why do not integrate parsing validator that is offer by GitHub for free for open source organization. I can help with it. The check will be triggered automatically when someone push something to master or on PR.

Klugier

U++ - one framework to rule them all.

[Updated on: Sun, 31 January 2021 23:38]

Report message to a moderator