How to add sample code to Clean ABAP?

[nununo]

#337 proposed linking to another repository which contains sample code. This constitutes a security problem. But it raises a good point. It would be great if some of the rules in the guide could be complemented with sample code whenever relevant. Some of the rules already have some inline code and that's fine. But sometimes (like what's proposed by #337), maybe longer and more complete examples would be helpful.

While I still don't know the best way to do this, I decided to open this issue to start a discussion about it.

I see two possible solutions (and I favour the first one):

A folder containing all the samples, one sample per file

Good: easy to consult by humans, easy to update, easy to link from the guide. The fact that everything stays under the same repository guarantees consistency;
Bad: Harder to install but... does it really matter?

Another github repository containing an abapGit repo

Good: it would be easy to install and test;
Bad: it's not easy to consult. I believe most of the times people won't need to install it. They'll want to look at it, read it and learn from it. And besides, if all the code is under the same abapGit package... you'd have to install the whole thing even if you'd only interested in a little bit. Not good.

Does it make sense to pursue this idea? If not, just close it 😄 Otherwise, let's have a go at it.

[ConjuringCoffee]

Which rules do you think would benefit from additional sample code? I feel like the goal should be that each Clean ABAP style guide should make sense in itself. I'd like to keep the amount of additional sample code to a minimum. Right now, I don't see the need yet. 😉