-
Notifications
You must be signed in to change notification settings - Fork 1
update Maintainers.md file and README with API information #3
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
update Maintainers.md file and README with API information #3
Conversation
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have updated @camaraproject/esim-remote-management_maintainers. With that I can approve the update of the MAINTAINERS.MD file. For the README.md you need still a codeowners review.
Please avoid going forward to mix changes of CODEOWERS and MAINTAINERS.MD file with other changes.
README.md
Outdated
| * Service API(s) “eSimRemoteManagement” (see APIBacklog.md) | ||
| * The API(s) provide(s) the API consumer with the ability to: | ||
| * §Short API scope description§ !! Add here a scope description according to the API proposal | ||
| * Remote management of users' esim card data, including esim activation, esim cancellation, esim query, etc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is esim a common form? Wouldn't be eSIM the correct writing?
Challenges are with lower CamelCase and lower camelCase requirements (e.g. in Spectral linting) ... looking forward for your proposals here.
I'm also not any more sure about the repository name ... eSimRemoteManagement is currently an exception within the API Repositories in CAMARA (only one starting with a lower letter). Asking ChatGPT the clear recommendation is EsimRemoteManagement, which looks somewhat wrong to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hdamker hello, after consideration by our team, we suggested that this API be named "eSimRemoteManagement". We have made corresponding changes to the "README.md" file to match the repository name.thanks
Update description of the ability of the API in README.md
SentianSun
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After consideration by our team, we suggested that this API be named "eSimRemoteManagement". We have made corresponding changes to the "README.md" file to match the repository name.
ChinaUnicomXiaoDongrui
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok
hdamker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
renowing my admin approval for the change of MAINTAINERS.MD
update Maintainers.md file and README with API information