search

NLeSC / guide

Software Development Guide
https://guide.esciencecenter.nl
Creative Commons Attribution 4.0 International
47 stars 30 forks source link

Example for different topics #281

Closed cpranav93 closed 1 month ago

cpranav93 commented 1 year ago

It would be easier for someone reading the guide if we could create a example project (on github) and walk them through this for different aspects of best practices (licensing, issues, PR, github pages, etc)

bouweandela commented 1 year ago

This would be a considerable maintenance burden for us though and it is quite generic, so maybe this would be more suitable for The Turing Way? Maybe there are existing examples?

egpbos commented 1 year ago

The Python template in a way does this, although specifically for Python. I agree it's a nice idea, but I would say it's a whole new project, outside of the direct scope of the Guide, mostly for the reasons @bouweandela mentions, i.e. maintenance burden. The Guide itself already has big maintenance issues.

That said, "maintenance burden" is partly guesswork. Why don't you try it @cpranav93? See how far you get and then we have an idea of how feasible it is.

In fact, I think this could be a nice little project to work out together with a few other RSEs. If you would like to do it like that, I will announce in a LLT on 23 November a new periodic activity focused on software quality. This idea would be a perfect candidate for that... Sorry for the vagueness, DM me if you want more details.

egpbos commented 1 month ago

If someone wants to pick this up, feel free to reopen.