Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include link to test isolation examples #337

Merged
merged 8 commits into from
Dec 1, 2023
Merged

Include link to test isolation examples #337

merged 8 commits into from
Dec 1, 2023

Conversation

sautermi0
Copy link
Member

This is kind of a bold one: I added a link to a repository I created. The repository contains examples for all test isolation tools available at the moment in the ABAP stack. We could either use this to replace the "Exploit the test tools" section or just as an addition.

Please let me know what you think 😉

@sautermi0 sautermi0 added enhancement New feature or request clean-abap idea Ideas, Requirements and Wishes labels Jul 25, 2023
@ConjuringCoffee
Copy link
Contributor

If a repository is linked like that in Clean ABAP, then it is "endorsed" and "approved" by Clean ABAP as well. I think this would be fine if the link pointed to a specific commit or file that can be reviewed as part of a pull request in here, but that isn't the case.

I don't want to accuse you of any ill intention or anything, but if the link just points to a personal repository (especially if it is a brand-new repository), then anything can be done to it without any interaction with the Clean ABAP repository.

@sautermi0
Copy link
Member Author

That's a good point. Actually, didn't think about the linked repository being being adapted to contain whatever... I just thought having a place with examples for the tools would be handy... Although, pointing to a specific commit would kind of defeat the purpose of always having a place with the current state...

An option to get the examples secured would be adding them to the CleanABAP-guide itself. But that isn't really what the guide is for, IMHO...

@nununo
Copy link

nununo commented Jul 25, 2023

I agree with the security concerns. And yet, it would be great to have sample code for this and a lot of other stuff mentioned in Clean ABAP. I just opened #338 to think on how to add sample code to the repo.

@KlausHaeuptleSAP
Copy link
Contributor

I like the idea of having code examples for the test isolation part and replace the existing chapter.

If examples would be added that could result in a more difficult change process for the guide. Since first all examples would need to be adapted to ensure that the examples are conform with the guide. But maybe it is worth it?

Maybe it is sufficient to add a note behind the link (Repository maintained by one of the core Clean ABAP maintainers and not necessarily completely up to date...)

@ConjuringCoffee
Copy link
Contributor

I agree with the security concerns.

To make my previous statement clear: I'm not primarily talking about security risks, but about conformity with the style guide.

Maybe it is sufficient to add a note behind the link (Repository maintained by one of the core Clean ABAP maintainers and not necessarily completely up to date...)

I like this approach! A disclaimer like "The repository doesn't necessarily reflect all Clean ABAP practice" should make it clear.

@sautermi0
Copy link
Member Author

That's a really good idea 👍 I now added a disclaimer, what do you think?

@sautermi0
Copy link
Member Author

Linked repository was turned into an official "SAP-Samples"-Repository.

@sautermi0 sautermi0 marked this pull request as ready for review October 23, 2023 14:21
@xtough xtough merged commit 21ad18d into SAP:main Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean-abap enhancement New feature or request idea Ideas, Requirements and Wishes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants