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

Update README.md #59

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Update README.md #59

merged 1 commit into from
Jan 30, 2024

Conversation

BatoolMM
Copy link
Member

This is to close #33

@RayStick RayStick self-requested a review January 30, 2024 08:50
Copy link
Member

@RayStick RayStick left a comment

Choose a reason for hiding this comment

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

Looks good! Feel free to merge -

My only question is around the versioning. Can you talk me through your approach with it?

The release is 0.5.0 but this says 0.1.0, as does the CITATION.cff file

@RayStick RayStick mentioned this pull request Jan 30, 2024
@BatoolMM
Copy link
Member Author

Sorry, fixed to 0.1.0 - is there anyway where it says 0.5.0?

@RayStick
Copy link
Member

Screenshot 2024-01-30 at 09 01 28

No worries! Thanks for changing it. I think it was only the tagged release that had 0.5.0
The name has changed but the tag is still 0.5.0 but I am not sure it is possible to change without a new release actually

@BatoolMM
Copy link
Member Author

That's a good catch, thank you for flagging it @RayStick, I have fixed it now!

To answer your first question, back in the days, I did try to use semantic versioning as best practices but that's long time ago. I need to review a lot of it and maybe come up with our own guidlines for versioning open source packages in RSF.

The reason I used 0.1.0, just because I want to start from somewhere and produce a DOI, it wasn't thought about carefully - but we should look it up more in the future.

@RayStick
Copy link
Member

@BatoolMM no problem, I am a bit rusty too. We can re-learn together.

@RayStick RayStick merged commit 25f417d into main Jan 30, 2024
1 check passed
@RayStick RayStick deleted the BatoolMM-patch-2 branch January 30, 2024 10:15
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.

Making the Package Citable
2 participants