-
Notifications
You must be signed in to change notification settings - Fork 32
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 #23
Conversation
Hi @ShutingQing, great to do some housekeeping here. Just two remarks:
|
So identity and consent management will not do some common api stuff for user authentification or consent, like this is only a repo for people to reach a agreement? |
That's not what i meant ... actually the discussion was moved into an own repository as there will be most probably "api stuff". But currently there isn't anything. I would consider the current state "work in progress" with the goal to come to v0.1.0 release eventually (using v0.1.0 already now could give the false impression that the content in |
Oh yeah, got what you mean. |
I fully agree. We should follow the guidelines set by Commonalities on this matter: https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/SupportingDocuments/Camara_Versioning_Guidelines.md |
Yes. Have marked the version to wip. So that's why I added a changelog file. As the guidelines states, our sub project needs to record main changes, including features, fixes and so on. Or that when it comes to version v0.3.0, people hardly can not what are done in v0.1.0, what are done in v0.2.0. |
Current Github PR template includes section: Changelog input
It is intended to provide short description of the PR that will be aggregated in the changelog when the release is published. |
Okay, sure. |
I have replaced the changelog file to template. And remove the placehoder api documentation readme. Pls review. |
Aligned with camaraproject#17
Removed past meeting from Upcoming Meetings section
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.
LGTM - I have commited my changes.
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.
Generally speaking, LGTM. The only thing we need to check is whether we want to add an entry in MeetingMinutes README.MD every time we add a new Meeting Minutes document...
|
||
2023/04/12 [Notes](MOM-2023-03-22.md) | ||
|
||
2023/05/03 [Notes](MOM-2023-05-03.md) |
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.
This will require us to update this README every time we add a meeting minutes document.
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.
looks good, thanks.
What type of PR is this?
What this PR does / why we need it:
Currently, we don't have a version control and changelog sys set up. So in the future, it's hardly can someone tell which part was did in v1, and which part was did in v2 or v3.
Solution:
So I created a changelog file. Each time someone commits, can leave a notes in changelog. Changes and versions are supposed to be included.
When we commit, we have to exclude sys file/folder generated by IDE, like I'm using IDEA, there will always be a .idea folder. So as other IDE.
Solution:
I added a gitignore file. People can add your IDE generated file/folder here. So each time when you commit, you do not have to exclude those folders before you do a git push.
Which issue(s) this PR fixes:
Linked to https://github.com/camaraproject/IdentityAndConsentManagement/issues/24
Special notes for reviewers:
Changelog input
docs