-
Notifications
You must be signed in to change notification settings - Fork 195
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 semantic_versioning.md #2842
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
Make it clearer and more extendable for the future.
I might be beiong opinionated though!
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
Can you link to this page on the release docs too @pinin4fjords ? |
Co-authored-by: James A. Fellows Yates <[email protected]>
@nf-core-bot fix linting |
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.
I like this. I also asked Seqera AI and here's what it gave:
Patch Release (1.4.4):
Fixing a typo in the pipeline documentation or help messages
Updating a dependency to patch a security vulnerability without changing functionality
Correcting a minor bug in result reporting that doesn't affect the actual analysis results
Optimizing a process to use less memory or run faster without changing its inputs or outputs
Fixing a minor issue in the pipeline's error handling or logging
Minor Release (1.5):
Adding support for a new input file format without changing existing format support
Introducing a new optional quality control step that doesn't affect the main analysis
Adding a new visualization option for existing results
Implementing a new caching strategy that improves performance but doesn't change results
Adding support for a new cloud computing platform without affecting existing platform support
Major Release (2.0):
Changing the default behavior of a core analysis step
Removing support for an outdated file format or tool
Restructuring the pipeline's output directory organization
Implementing a new parallelization strategy that requires users to specify different resource allocations
Changing the pipeline's command-line interface structure
Modifying how configuration files are structured and processed
Upgrading to a new major version of Nextflow that requires changes in how users interact with the pipeline
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
This is good for extra examples, but IMO some the examples are maybe too generic: e.g.
I think we should make it more explitily/modular using our language (like as I've suggested) as it'll be more likely be picked up by a developer when skimming the text. Sort of like 'Have you changed a parameter name?' is going to be more eye catching 'yes I did that' than just 'did an interface change'. What do others think? |
Having it more tuned to our use case is definitely going to help. It's not an easy task though because words can mean different things to different people resulting in some being confused and others going "yeah, that's clear as day - I did that". |
Co-authored-by: Simon Pearce <[email protected]>
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
…semantic_versioning.md
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
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.
What about adding a checklist for each type of release (see my review suggestion)?
sites/docs/src/content/docs/guidelines/pipelines/requirements/semantic_versioning.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Jose Espinosa-Carrasco <[email protected]>
Better outline semantic versioning, and try to persuade users to bump major versions when they should.
@netlify /docs/guidelines/pipelines/requirements/semantic_versioning