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

Add changelog and gitignore file #28

Closed
wants to merge 9 commits into from

Conversation

ShutingQing
Copy link
Collaborator

@ShutingQing ShutingQing commented May 9, 2023

Hi all, I add some contents in documentations. Like i put the meeting info in the main page readme, and add more complementary info, so new people can easily get how sim swap can help on preventing fraud. Also, i added a changelog and a gitignore file. Currently, we don't know what exactly one version is doing. Like I found somewhere in project marks currently it's v0.3.0, but somewhere else is showing now it's v0.5.0. So maybe a changelog is needed.

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - This is useful.
One comment: do we still have the Tuesday calls - I understood @DT-DawidWroblewski plans to cancel them.

@ShutingQing
Copy link
Collaborator Author

Thanks - This is useful. One comment: do we still have the Tuesday calls - I understood @DT-DawidWroblewski plans to cancel them.

Welcome.

@ShutingQing
Copy link
Collaborator Author

So currently, the version is v0.3.0 or v0.5.0? I found both in project.

@ShutingQing
Copy link
Collaborator Author

So currently, the version is v0.3.0 or v0.5.0? I found both in project.

@bigludo7 @DT-DawidWroblewski Hi, Ludovic Dawid, we gonna have a weekly meeting on today or Thursday? Thursday right?

@DT-DawidWroblewski
Copy link
Collaborator

So currently, the version is v0.3.0 or v0.5.0? I found both in project.

@bigludo7 @DT-DawidWroblewski Hi, Ludovic Dawid, we gonna have a weekly meeting on today or Thursday? Thursday right?

Hi! I canceled Tuesday's, so we're meeting on Thursday.

@monamok
Copy link
Collaborator

monamok commented May 23, 2023

The meeting is bi-weekly so the next meeting is on Thursday, June 1st.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@DT-DawidWroblewski DT-DawidWroblewski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check review comments to this PR

@ShutingQing
Copy link
Collaborator Author

The meeting is bi-weekly so the next meeting is on Thursday, June 1st.

Okay, got it thx.

@ShutingQing
Copy link
Collaborator Author

please check review comments to this PR

Thanks. Will do.

@ShutingQing
Copy link
Collaborator Author

please check review comments to this PR

Have modified. Pls check review.

@bigludo7 bigludo7 self-requested a review May 23, 2023 14:50
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - not sure to understand about the gitignore file & content. Some one can explain me?

@ShutingQing
Copy link
Collaborator Author

Thanks - not sure to understand about the gitignore file & content. Some one can explain me?

Yes sure. Basically if you use Intellij IDEA or Visual Studio for the project. The IDE will automatically generate some folders or files locally, like .idea folder, which contains some configuration files for the project. So when you try to git push, you have to exclude those files, but they will be generated again later.

So we can include those in gitignore file, so those will be ignored by git tool each time when you commit. The contents in gitignore are IDE generated configuration files, like .idea foler, .vscode folder .

@bigludo7
Copy link
Collaborator

Thank you @ShutingQing !

Copy link
Collaborator

@monamok monamok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @ShutingQing,

thank you for your contribution. I added some comments about your proposal.

MAINTAINERS.MD Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated

## Version Details
**Note Meeting Minutes commit histories are not included in ChangeLogs here.**

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add the following description that we have in https://github.com/camaraproject/SimSwap/tree/main/documentation/API_documentation#introduction

CAMARA community agreed to temporarily enable SIM swap API in two complementary flavors:

  • Based on CAMARA standardization guidelines, that enables API service on a dedicated endpoint and follows CAMARA AuthN/AuthZ concept. More details available here
  • Based on GSMA Mobile Connect standardized family of Identity APIs, that delivers Account Takeover Protection service. More details available here

This way in each release note we can clarify versions for each flavor and try to avoide more confusion:

  • We must indicate that the first release was v0.3.0 for CAMARA version and v0.1.0 for MC version (MWC release).
  • Second release is going to be with v0.4.0 for CAMARA flavor and for MC flavor the version it is still v0.1.0.

@@ -12,20 +12,31 @@ Repository to describe, develop, document and test the SimSwap API family
## Scope
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't change the scope information. We already have other detailed definition pages in order to get detailed information that you're linking bellow (which is helpful). I don't think it's a good idea to repeat it partially here.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to our conversation in the last week's meeting please remove the proposed scope changes.

Copy link
Collaborator

@monamok monamok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @ShutingQing
I rereviewed the changes and added some comments.

# v0.4.0

### Added
* [2023.03.31] - [v0.4.0] - Guidelines alignment errors and camel case. [Details](https://github.com/camaraproject/SimSwap/pull/20)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one was a change/alignment to the guidelines. Please move it to Changed section



### Changed
* [2023.03.31] - [v0.4.0] - API documentation repo fine tuning. [Details](https://github.com/camaraproject/SimSwap/pull/22)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one was a PR to fix links. Please move it to Fixed section.

### Changed
* [2022.01.24] - [v0.3.0] - Reshape readme and resources file. [Details](https://github.com/camaraproject/SimSwap/pull/13)
* [2022.02.07] - [v0.3.0] - Update readme. [Details](https://github.com/camaraproject/SimSwap/pull/17)
* [2022.02.21] - [v0.3.0] - Repo fine tuning. [Details](https://github.com/camaraproject/SimSwap/pull/18)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR was a fix.

# v0.1.0

### Added
* [2022.12.29] - [v0.3.0] - Add MC ATP yaml. [Details](https://github.com/camaraproject/SimSwap/pull/8)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [2022.12.29] - [v0.3.0] - Add MC ATP yaml. [Details](https://github.com/camaraproject/SimSwap/pull/8)
* [2022.12.29] - [v0.1.0] - Add MC ATP yaml. [Details](https://github.com/camaraproject/SimSwap/pull/8)

@@ -12,20 +12,31 @@ Repository to describe, develop, document and test the SimSwap API family
## Scope
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to our conversation in the last week's meeting please remove the proposed scope changes.



# v0.3.0

Copy link
Collaborator

@monamok monamok Jun 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add here somthing like this:

This is the first pre-release of Sim Swap API - CAMARA flavor

Otherwise it's gonna be confusing that there is no 0.1 nor 0.2.

And we can add similar comment in MC part:
This is the first pre-release of Sim Swap API - MC flavor

@monamok monamok mentioned this pull request Jun 6, 2023
@hdamker
Copy link
Collaborator

hdamker commented Sep 1, 2023

Seems that this PR got stale. And as there a decision to not keep the MC version of SIM Swap within the repository it would make sense to setup a complete different CHANGELOG.md, starting a "First (alpha?) release of CAMARA SimSwap"?

Close this PR?

@ShutingQing ShutingQing closed this Sep 4, 2023
@fernandopradocabrillo
Copy link
Collaborator

fernandopradocabrillo commented Sep 6, 2023

Seems that this PR got stale. And as there a decision to not keep the MC version of SIM Swap within the repository it would make sense to setup a complete different CHANGELOG.md, starting a "First (alpha?) release of CAMARA SimSwap"?

Close this PR?

@hdamker do you mean start the changelog on the current version and update from there, not including previous versions and history? (only CAMARA referred, I would not include the MC history since it is no longer relevant)

@hdamker
Copy link
Collaborator

hdamker commented Sep 6, 2023

@fernandopradocabrillo it depends ...

(a) if there were previous version of the CAMARA API which the sub projects knows that they were used for implementations, it would make sense to start the changelog with them - in QoD we did this v0.1.0 which was the very initial contribution and we had already an implementation for that provided. But we called only the v0.8.0 the first alpha version of QoD.
(b) if there no previous release worth to mention you can start the changelog with the current version (even if it is for internal reason not any more v0.1.0)

In case of (a) you have to find the right commit within the main branch and create the release on that. And you should do it before you do the current release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants