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

Introduce instructions on package versioning #178

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

m-kolomanski
Copy link
Collaborator

Hi everyone,

with rapid development of the package, we are just few critical features and fixes away from having a stable version of the package, which could be published on CRAN. With that, I believe it would be beneficial to introduce instructions and requirements on package versioning. Proper, semantic versioning is not an important issue at this point, but since #172 added the possibility of installing the package with pak, tracking changes in the development version will be beneficial.

Therefore, I would like to suggest adding the requirement of bumping the package version in DESCRIPTION file, in all PRs which introduce code changes, before merging. We could go with just incrementing the last, .9000 part of the version, as long as we wish, and then when we believe the package is ready for publication, start off with version 0.1.0.

This pull request introduces two changes:

  • Adds information on package version bumping to the CONTRIBUTING.md file
  • Adds Package version is incremented to the checklist in the pull request template.

Please let me know what you think of introducing this at this point in time, feedback welcome. I think this will get everyone in the team in the healthy habit of incrementing the package version, in preparation of maintaining the officialy released application.

Copy link
Collaborator

@js3110 js3110 left a comment

Choose a reason for hiding this comment

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

@m-kolomanski I think this is a great idea, especially as we are definitely getting close to having a solid version of the app. Thanks :)

@Gero1999
Copy link
Collaborator

Sounds a good plan! I would also suggest giving a look to the GitHub workflow. Do you think is possible to make it update the DESCRIPTION version on each successful merge?

@m-kolomanski
Copy link
Collaborator Author

@Gero1999, this is exactly what I have tried doing with this commit (basically a script to bump package version automatically). I have tested it, in general it works, but not with our setup. We require pull requests that have 2 approvals in order to add changes, so when the bot/script tries to change the package number it gets an error.

Copy link
Collaborator

@Gotfrid Gotfrid left a comment

Choose a reason for hiding this comment

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

Great idea, @m-kolomanski. I think for now pull request template is a good enough solution, let's not block this PR over some merge problems (imo).

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