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

Check guidelines for release and add corrections #132

Merged
merged 12 commits into from
Oct 29, 2024

Conversation

atrigila
Copy link
Collaborator

@atrigila atrigila commented Oct 13, 2024

Do: nf-core principles

Do: Local code and modules

  • Do local scripts in bin/ have author and license embedded?
    • Local script licenses if written for the pipeline should not GPL, but ideally MIT (matching with pipeline code, upon which is assumed if not otherwise specified)
  • Do all local modules have docker/singularity/conda declarations?
    • Are they ideally in bioconda/biocontainers
  • Do all local modules conda/container tool declarations have versions? (and not latest, dev etc.)
  • Do all local modules report versions (if applicable)?
    • Simple modules with e.g. single grep operations not necessary
    • It would be good to add with more complex operations such as awk
  • Should any local modules be in nf-core/modules?

Do: Documentation

  • Documentation is only on the nf-core website (not pointed to other non-nf-core standard places, e.g. not read the docs )
  • Is documentation sufficiently described (usage.md, output.md, nextflow_schema.json)?
    • nextflow_schema.json: check if types are correct and that default and enum are used where applicable
  • Are there any typos in the documentation (usage.md, output.md, nextflow_schema.json)
  • Is CHANGELOG sufficiently filled in?
    • Check version system is three-point SemVer e.g. 2.1.0
    • Has the date been updated?
  • Check citation formatting consistency in CIATIONS.md
  • Check that all tools are cited
  • Check that (all) pipeline author(s) listed themselves in the manifest and other contributors are added in the README

Do: Code

  • Check no overly non-template components (no read the docs, entirely custom logo etc.)
  • Check for general code readability
  • Check for possible code bugs
  • Check for consistency in parameters
    • i.e. snake_case
    • All boolean parameters evaluate to false (e.g. bad: params.run_step = true{:groovy}, good: params.skip_step = false{:groovy} )
  • Check manifest includes DOI (if present) etc.

Don't have to do

  • Review module code from nf-core/modules
  • Comment on scientific content (unless you are familiar with the topic)
  • Major code optimisation
    • You can suggest small code optimisations
    • Larger ones you can recommend, but shouldn't necessarily be require for release (hopefully this should have been covered during development PRs)

@atrigila atrigila added this to the v0.99.0 milestone Oct 13, 2024
@atrigila atrigila self-assigned this Oct 13, 2024
@LouisLeNezet LouisLeNezet marked this pull request as ready for review October 28, 2024 08:58
@LouisLeNezet LouisLeNezet marked this pull request as draft October 28, 2024 09:01
@atrigila atrigila requested a review from LouisLeNezet October 28, 2024 09:51
@LouisLeNezet LouisLeNezet linked an issue Oct 28, 2024 that may be closed by this pull request
3 tasks
@LouisLeNezet
Copy link
Collaborator

Can you change the ## v1.0dev - [date] in the CHANGELOG to ## v1.0.0 - [2024-10-28]

@LouisLeNezet LouisLeNezet linked an issue Oct 28, 2024 that may be closed by this pull request
2 tasks
@atrigila atrigila marked this pull request as ready for review October 29, 2024 08:31
@atrigila atrigila requested a review from LouisLeNezet October 29, 2024 08:31
README.md Outdated Show resolved Hide resolved
@LouisLeNezet LouisLeNezet merged commit e351bb3 into nf-core:dev Oct 29, 2024
11 checks passed
LouisLeNezet added a commit to LouisLeNezet/phaseimpute that referenced this pull request Oct 29, 2024
* typo fixes in readme

* remove some to-dos

* remove todos, add bibliography

* add conditional detection of tools

* add missing tools to citations

* add conditional params

* add release name and date

* bump versions

* add contributors and reviewers

* Update README.md

* Update README.md

* Update README.md

---------

Co-authored-by: Louis LE NEZET <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Check adherence to guidelines for pipeline release
2 participants