Cwa-documentation: Provide visibility of information in all repository elements

[mss1010]

Avoid duplicates

• [x] Question is not already answered in the FAQ
• [x] Question has not already been asked in another issue

Your Question

In some elements, like PRs, SAP internal jira issues are referenced. But the public does not have read access to this SAP jira workspace. This in itself is fine I guess.
But in this github repository, it should be ensured that everyone has access to the relevant information. So, if an internal issue is mentioned or referenced, additional information about the contents of these issues should be provided, so that the information available on github is transparent and consistent.

To make this abstract description more clear, here is an example: In PR corona-warn-app/cwa-app-ios#883 the description consists purely of references to two internal SAP jira issues. So, for a github user, it´s not clear what this PR does.

So, to summarize, in some way it should be ensured, that all relevant information is visible to any github user.

[GPclips-zz]

Hello @mss1010,

thank you for reaching out. I will discuss this topic internally and get back to you with an answer as soon as possible.
I also moved this issue to the documentation repository, since this topic should also be addressed for both apps (iOS and Android).

Thanks,
LMM

Corona-Warn-App Open Source Team

[mss1010]

Hello @GPclips, are there any news on that?

[svengabr]

Hello @mss1010, unfortunately, it is not possible to have public access to the SAP Jira. However we, the open source team, are always taking a look at the attached Jira issues to make sure you always have all the information available in the open issues.

Best regards,
SG

Corona-Warn-App Open Source Team

[daimpi]

Another more recent example where only a jira issue is mentioned can be found here: https://github.com/corona-warn-app/cwa-app-android/pull/1048

[mss1010]

Maybe in such cases, the developers could copy and paste the main text of the jira issue, or write a summary?

[GPclips-zz]

As @svengabr mentioned, we always try our very best to add all the required information. I will discuss this topic internally again to make sure all of our members are aware of it.
I will go on and close the ticket. It can be reopened, if it is needed.