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 #23

Merged
merged 8 commits into from
Jun 1, 2023
Merged

Conversation

ShutingQing
Copy link
Collaborator

@ShutingQing ShutingQing commented May 10, 2023

What type of PR is this?

  • documentation

What this PR does / why we need it:

  1. Problem:
    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.

  1. Problem:
    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.

  1. Added some other complimentary documentations

Which issue(s) this PR fixes:

Linked to https://github.com/camaraproject/IdentityAndConsentManagement/issues/24

Special notes for reviewers:

Changelog input

 release-note

v0.1.0 wip documentation updates

#### Additional documentation 

This section can be blank.



docs

@ShutingQing ShutingQing changed the title Add some docs Add Changelog and gitignore file May 10, 2023
@ShutingQing ShutingQing changed the title Add Changelog and gitignore file Add changelog and gitignore file May 10, 2023
@hdamker
Copy link
Collaborator

hdamker commented May 11, 2023

Hi @ShutingQing, great to do some housekeeping here.

Just two remarks:

  • There is no such thing as a 0.1.0 release yet, as there is no API definition as well (other sub projects are updating the changelog with the github mechanisms as part of a release with the most important points for users of the API definition(s), but that can done differently)
  • documentation/API_documentation/README.MD is not meant to hold the documentation but it is just a placeholder in the directory until there is the first documentation file will be placed (i would also propose not to mix housekeeping and documentation content within one PR)

@ShutingQing
Copy link
Collaborator Author

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?

@hdamker
Copy link
Collaborator

hdamker commented May 16, 2023

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 main is already released).

@ShutingQing
Copy link
Collaborator Author

ith the goal to

Oh yeah, got what you mean.

@ShutingQing ShutingQing requested a review from jpengar as a code owner May 17, 2023 03:18
@jpengar
Copy link
Collaborator

jpengar commented May 17, 2023

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 main is already released).

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

@ShutingQing
Copy link
Collaborator Author

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 main is already released).

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.

@rartych
Copy link
Collaborator

rartych commented May 17, 2023

Current Github PR template includes section:

Changelog input

 release-note

It is intended to provide short description of the PR that will be aggregated in the changelog when the release is published.
So instead of updating changelog after each PR merge, we assume that the needed content is provided in PRs and can be used to describe the release.
Since we are in the early stage of the subproject as discussed above, I propose to keep just the template of CHANGELOG.md file.

@ShutingQing
Copy link
Collaborator Author

Okay, sure.

@ShutingQing
Copy link
Collaborator Author

I have replaced the changelog file to template. And remove the placehoder api documentation readme. Pls review.

rartych added 2 commits May 22, 2023 17:31
Removed past meeting from Upcoming Meetings section
Copy link
Collaborator

@rartych rartych left a 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.

Copy link
Collaborator

@jpengar jpengar left a 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)
Copy link
Collaborator

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

looks good, thanks.

@jpengar jpengar merged commit d0298a4 into camaraproject:main Jun 1, 2023
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.

4 participants