From 82d09253bfde33e97278b5fbbed43743e3c45662 Mon Sep 17 00:00:00 2001 From: Daniel-VM Date: Wed, 3 Apr 2024 11:38:28 +0200 Subject: [PATCH 1/3] add reviewer suggestions in PR #122 --- .editorconfig | 6 +----- .github/CONTRIBUTING.md | 14 +++++++++----- .github/PULL_REQUEST_TEMPLATE.md | 1 - .github/workflows/release-announcements.yml | 4 ++-- .nf-core.yml | 3 +++ README.md | 2 +- main.nf | 2 +- nextflow.config | 2 +- nextflow_schema.json | 18 ++++++++++-------- .../local/utils_nfcore_bacass_pipeline/main.nf | 2 +- 10 files changed, 29 insertions(+), 25 deletions(-) diff --git a/.editorconfig b/.editorconfig index dd9ffa53..72dda289 100644 --- a/.editorconfig +++ b/.editorconfig @@ -28,10 +28,6 @@ indent_style = unset [/assets/email*] indent_size = unset -# ignore Readme -[README.md] -indent_style = unset - -# ignore python +# ignore python and markdown [*.{py,md}] indent_style = unset diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 24edde80..de41a8e0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -26,11 +26,7 @@ If you're not used to this workflow with git, you can start with some [docs from ## Tests -You have the option to test your changes locally by running the pipeline. For receiving warnings about process selectors and other `debug` information, it is recommended to use the debug profile. Execute all the tests with the following command: - -```bash -nf-test test --profile debug,test,docker --verbose -``` +You have the option to test your changes locally by running the pipeline. When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests. Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then. @@ -51,6 +47,14 @@ Each `nf-core` pipeline should be set up with a minimal set of test-data. If there are any failures then the automated tests fail. These tests are run both with the latest available version of `Nextflow` and also the minimum required version that is stated in the pipeline code. +You can run pipeline tests with the following command: + +```bash +nextflow run nf-core/bacass \ + -profile , \ + --outdir +``` + ## Patch :warning: Only in the unlikely and regretful event of a release happening with a bug. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5720228a..9eb73e01 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,7 +18,6 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/baca - [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/bacass/tree/master/.github/CONTRIBUTING.md) - [ ] If necessary, also make a PR on the nf-core/bacass _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository. - [ ] Make sure your code lints (`nf-core lint`). -- [ ] Ensure the test suite passes (`nf-test test main.nf.test -profile test,docker`). - [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir `). - [ ] Usage Documentation in `docs/usage.md` is updated. - [ ] Output Documentation in `docs/output.md` is updated. diff --git a/.github/workflows/release-announcements.yml b/.github/workflows/release-announcements.yml index d468aeaa..5ada136c 100644 --- a/.github/workflows/release-announcements.yml +++ b/.github/workflows/release-announcements.yml @@ -12,7 +12,7 @@ jobs: - name: get topics and convert to hashtags id: get_topics run: | - curl -s https://nf-co.re/pipelines.json | jq -r '.remote_workflows[] | select(.full_name == "${{ github.repository }}") | .topics[]' | awk '{print "#"$0}' | tr '\n' ' ' >> $GITHUB_OUTPUT + echo "topics=$(curl -s https://nf-co.re/pipelines.json | jq -r '.remote_workflows[] | select(.full_name == "${{ github.repository }}") | .topics[]' | awk '{print "#"$0}' | tr '\n' ' ')" >> $GITHUB_OUTPUT - uses: rzr/fediverse-action@master with: @@ -25,7 +25,7 @@ jobs: Please see the changelog: ${{ github.event.release.html_url }} - ${{ steps.get_topics.outputs.GITHUB_OUTPUT }} #nfcore #openscience #nextflow #bioinformatics + ${{ steps.get_topics.outputs.topics }} #nfcore #openscience #nextflow #bioinformatics send-tweet: runs-on: ubuntu-latest diff --git a/.nf-core.yml b/.nf-core.yml index 3c4e0a3f..a8ab3441 100644 --- a/.nf-core.yml +++ b/.nf-core.yml @@ -2,6 +2,9 @@ repository_type: pipeline lint: files_exist: - conf/igenomes.config + files_unchanged: + - .github/CONTRIBUTING.md + - .github/PULL_REQUEST_TEMPLATE.md nextflow_config: - config_defaults: - params.dfast_config diff --git a/README.md b/README.md index 030e06fe..f94c4c2d 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ For users that only have Nanopore data, the pipeline quality trims these using [ The pipeline can then perform long read assembly utilizing [Unicycler](https://github.com/rrwick/Unicycler), [Miniasm](https://github.com/lh3/miniasm) in combination with [Racon](https://github.com/isovic/racon), [Canu](https://github.com/marbl/canu) or [Flye](https://github.com/fenderglass/Flye) by using the [Dragonflye](https://github.com/rpetit3/dragonflye)(\*) pipeline. Long reads assembly can be polished using [Medaka](https://github.com/nanoporetech/medaka) or [NanoPolish](https://github.com/jts/nanopolish) with Fast5 files. > [!NOTE] -> Dragonflye is a comprehensive pipeline designed for genome assembly of Oxford Nanopore Reads. It facilitates the utilization of Flye (default), Miniasm, and Raven assemblers, along with Racon(default) and Medaka polishers. For more information, visit the [Dragonflye GitHub](https://github.com/rpetit3/dragonflye) repository. +> Dragonflye is a comprehensive pipeline designed for genome assembly of Oxford Nanopore Reads. It facilitates the utilization of Flye (default), Miniasm, and Raven assemblers, along with Racon (default) and Medaka polishers. For more information, visit the [Dragonflye GitHub](https://github.com/rpetit3/dragonflye) repository. ### Hybrid Assembly diff --git a/main.nf b/main.nf index 5d271354..8874c844 100644 --- a/main.nf +++ b/main.nf @@ -17,7 +17,7 @@ nextflow.enable.dsl = 2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */ -include { BACASS } from './workflows/bacass' +include { BACASS } from './workflows/bacass' include { PIPELINE_INITIALISATION } from './subworkflows/local/utils_nfcore_bacass_pipeline' include { PIPELINE_COMPLETION } from './subworkflows/local/utils_nfcore_bacass_pipeline' diff --git a/nextflow.config b/nextflow.config index 3e398340..09198a1c 100644 --- a/nextflow.config +++ b/nextflow.config @@ -28,7 +28,7 @@ params { dragonflye_args = '' // Assembly polishing - polish_method = 'medaka' + polish_method = 'medaka' // Allowed: ['medaka', 'nanopolish'] // Annotation annotation_tool = 'prokka' // Allowed: ['prokka', 'bakta','dfast'] diff --git a/nextflow_schema.json b/nextflow_schema.json index 2eb706e0..0b1d176b 100644 --- a/nextflow_schema.json +++ b/nextflow_schema.json @@ -87,15 +87,16 @@ "type": "string", "default": "unicycler", "fa_icon": "fas fa-puzzle-piece", - "description": "The assembler to use for assembly. Available options are `Unicycler`, `Canu`, `Miniasm`, or `Dragonflye`. The latter trhee are only available for long-read data, whereas Unicycler can be used for short or hybrid assembly projects.", + "description": "The assembler to use for assembly. Use the appropriate assembler according to the chosen assembly_type. Refer to the README.md for further clarification.", "enum": ["unicycler", "canu", "miniasm", "dragonflye"] }, "assembly_type": { "type": "string", "default": "short", "fa_icon": "fas fa-fingerprint", - "help_text": "This adjusts the type of assembly done with the input data and can be any of `long`, `short` or `hybrid`. Short & Hybrid assembly will always run Unicycler, whereas long-read assembly can be configured separately using the `--assembler` parameter.", - "description": "Which type of assembly to perform." + "help_text": "This adjusts the type of assembly done with the input data and can be any of `long`, `short` or `hybrid`.", + "description": "Which type of assembly to perform.", + "enum": ["short", "long", "hybrid"] }, "unicycler_args": { "type": "string", @@ -106,7 +107,7 @@ "canu_mode": { "type": "string", "enum": ["-pacbio", "-nanopore", "-pacbio-hifi", "null"], - "description": "Allowed technologies for long read assembly : [\"-pacbio\", \"-nanopore\", \"-pacbio-hifi\"]" + "description": "Allowed technologies for long read assembly." }, "canu_args": { "type": "string", @@ -116,7 +117,7 @@ "dragonflye_args": { "type": "string", "description": "Extra arguments for [Dragonflye](https://github.com/rpetit3/dragonflye#usage)", - "help_text": "This advanced option allows you to add extra arguments to Dragonflye (e.g.: `\"--gsize 2.4m\"`). For those arguments with no values/options associated (e.g.: `\"--nopolish\"` or `\"--nofilter\"`...) you need to add an extra space at the begining of the input string to params.dragonflye_args. Example: --params.dragonflye_args ' --nopolish'" + "help_text": "This advanced option allows you to add extra arguments to Dragonflye (e.g.: `\"--gsize 2.4m\"`). For those arguments with no values/options associated (e.g.: `\"--nopolish\"` or `\"--nofilter\"`...) you need to add an extra space at the begining of the input string to params.dragonflye_args. Example: `--params.dragonflye_args ' --nopolish'`" } } }, @@ -132,7 +133,8 @@ "default": "medaka", "fa_icon": "fas fa-hotdog", "description": "Which assembly polishing method to use.", - "help_text": "Can be used to define which polishing method is used by default for long reads. Default is `medaka`, available options are `nanopolish` or `medaka`." + "help_text": "Can be used to define which polishing method is used by default for long reads.", + "enum": ["medaka", "nanopolish"] } } }, @@ -146,7 +148,7 @@ "annotation_tool": { "type": "string", "default": "prokka", - "description": "The annotation method to annotate the final assembly. Default choice is `prokka`, but the `dfast` tool is also available. For the latter, make sure to create your specific config if you're not happy with the default one provided. See [#dfast_config](#dfastconfig) to find out how.", + "description": "The annotation method to annotate the final assembly.", "enum": ["prokka", "bakta", "dfast"] }, "prokka_args": { @@ -172,7 +174,7 @@ "type": "string", "default": "assets/test_config_dfast.py", "description": "Specifies a configuration file for the [DFAST](https://github.com/nigyta/dfast_core) annotation method.", - "help_text": "This can be used instead of PROKKA if required to specify a specific config file for annotation. If you want to know how to create your config file, please refer to the [DFAST](https://github.com/nigyta/dfast_core) readme on how to create one. The default config (`assets/test_config_dfast.py`) is just included for testing, so if you want to annotate using DFAST, you have to create a config!" + "help_text": "If you want to know how to create your config file, please refer to the [DFAST](https://github.com/nigyta/dfast_core) readme on how to create one. The default config (`assets/test_config_dfast.py`) is just included for testing, so if you want to annotate using DFAST, you have to create a config!" } } }, diff --git a/subworkflows/local/utils_nfcore_bacass_pipeline/main.nf b/subworkflows/local/utils_nfcore_bacass_pipeline/main.nf index e02fe978..df36a195 100644 --- a/subworkflows/local/utils_nfcore_bacass_pipeline/main.nf +++ b/subworkflows/local/utils_nfcore_bacass_pipeline/main.nf @@ -235,7 +235,7 @@ def toolBibliographyText() { "
  • Wood, D.E., Lu, J. & Langmead, B. Improved metagenomic analysis with Kraken 2. Genome Biol 20, 257 (2019). https://doi.org/10.1186/s13059-019-1891-0
    • ", "
  • Wick RR, Judd LM, Gorrie CL, Holt KE. Unicycler: Resolving bacterial genome assemblies from short and long sequencing reads. PLoS Comput Biol. 2017 Jun 8;13(6):e1005595. doi: 10.1371/journal.pcbi.1005595.
    • ", "
  • Heng Li, Minimap and miniasm: fast mapping and de novo assembly for noisy long sequences, Bioinformatics, Volume 32, Issue 14, July 2016, Pages 2103–2110, https://doi.org/10.1093/bioinformatics/btw152
    • ", - "
  • [rpetit/dragonflye](https://github.com/rpetit3/dragonflye)
    • ", + "
  • Petit III, R. A. dragonflye: assemble bacterial isolate genomes from Nanopore reads (Version 1.1.2). https://github.com/rpetit3/dragonflye
    • ", "
  • Vaser R, Sović I, Nagarajan N, Šikić M. Fast and accurate de novo genome assembly from long uncorrected reads. Genome Res. 2017 May;27(5):737-746. doi: 10.1101/gr.214270.116.
    • ", "
  • Koren S, Walenz BP, Berlin K, Miller JR, Bergman NH, Phillippy AM. Canu: scalable and accurate long-read assembly via adaptive k-mer weighting and repeat separation. Genome Res. 2017 May;27(5):722-736. doi: 10.1101/gr.215087.116.
    • ", "
  • Medaka: Sequence correction provided by ONT Research. https://github.com/nanoporetech/medaka,
    • ", From 00429c741c57631bde3f60a2c858d34e1f006606 Mon Sep 17 00:00:00 2001 From: Daniel-VM Date: Wed, 3 Apr 2024 13:00:27 +0200 Subject: [PATCH 2/3] add reviewer 2 suggestions in PR #122 --- CHANGELOG.md | 25 +++++++++++++++- conf/test.config | 10 +++---- conf/test_dfast.config | 8 ++--- conf/test_full.config | 4 +-- conf/test_hybrid.config | 6 ++-- conf/test_hybrid_dragonflye.config | 8 ++--- conf/test_long.config | 8 ++--- conf/test_long_dragonflye.config | 10 +++---- conf/test_long_miniasm.config | 8 ++--- .../utils_nfcore_bacass_pipeline/main.nf | 29 ++----------------- 10 files changed, 57 insertions(+), 59 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c0d94dbe..d69e8489 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### `Changed` - [#111](https://github.com/nf-core/bacass/pull/111) - Update nf-core/bacass to 2.12, and [#117](https://github.com/nf-core/bacass/pull/117) to 2.13.1 `TEMPLATE`. -- [#120](https://github.com/nf-core/bacass/pull/120) - Update local and nf-core modules (version update an minnor code changes). ### `Added` @@ -20,6 +19,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### `Dependencies` +- [#120](https://github.com/nf-core/bacass/pull/120) - Update local and nf-core modules (version update an minnor code changes). + +| Tool | Previous version | New version | +| ---------- | ---------------- | ----------- | +| Bakta | 1.8.2 | 1.9.3 | +| Canu | 2.2 | - | +| Dragonflye | 1.1.2 | - | +| Fastp | 0.23.4 | - | +| Kraken2 | 2.1.2 | - | +| Miniasm | 0.3_r179 | - | +| Minimap2 | 2.2 | 2.24 | +| Nanoplot | 1.41.6 | - | +| Porechop | 0.2.4 | - | +| Prokka | 1.14.6 | - | +| Quast | 5.2.0 | - | +| Racon | 1.4.20 | - | +| Samtools | 1.17 | 1.19.2 | +| Untar | 1.34 | - | +| Dfast | 1.2.20 | - | +| Medaka | 1.4.3-0 | - | +| Nanopolish | 0.14.0 | - | +| PycoQC | 2.5.2 | - | +| Unicycler | 0.4.8 | - | + ### `Deprecated` ## v2.1.0 nf-core/bacass: "Navy Steel Swordfish" - 2023/10/20 diff --git a/conf/test.config b/conf/test.config index c827fd2d..165f51e7 100644 --- a/conf/test.config +++ b/conf/test.config @@ -23,9 +23,9 @@ params { input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_short.tsv' // some extra args to speed tests up - unicycler_args="--no_correct --no_pilon" - prokka_args=" --fast" - assembly_type = 'short' - skip_pycoqc = true - skip_kraken2 = true + unicycler_args = "--no_correct --no_pilon" + prokka_args = " --fast" + assembly_type = 'short' + skip_pycoqc = true + skip_kraken2 = true } diff --git a/conf/test_dfast.config b/conf/test_dfast.config index b1b02c4b..3fa0e950 100644 --- a/conf/test_dfast.config +++ b/conf/test_dfast.config @@ -23,9 +23,9 @@ params { input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_short.tsv' // some extra args to speed tests up - unicycler_args="--no_correct --no_pilon" + unicycler_args = "--no_correct --no_pilon" annotation_tool = 'dfast' - assembly_type = 'short' - skip_pycoqc = true - skip_kraken2 = true + assembly_type = 'short' + skip_pycoqc = true + skip_kraken2 = true } diff --git a/conf/test_full.config b/conf/test_full.config index 9432d763..b89f4c4b 100644 --- a/conf/test_full.config +++ b/conf/test_full.config @@ -15,6 +15,6 @@ params { config_profile_description = 'Full test dataset to check pipeline function' // Input data for full size test - input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_full.tsv' - kraken2db = 'https://genome-idx.s3.amazonaws.com/kraken/k2_standard_8gb_20210517.tar.gz' + input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_full.tsv' + kraken2db = 'https://genome-idx.s3.amazonaws.com/kraken/k2_standard_8gb_20210517.tar.gz' } diff --git a/conf/test_hybrid.config b/conf/test_hybrid.config index c27563a8..b3a560ae 100644 --- a/conf/test_hybrid.config +++ b/conf/test_hybrid.config @@ -23,7 +23,7 @@ params { input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_hybrid.tsv' // some extra args to speed tests up - assembly_type='hybrid' - prokka_args=" --fast" - skip_kraken2 = true + assembly_type = 'hybrid' + prokka_args = " --fast" + skip_kraken2 = true } diff --git a/conf/test_hybrid_dragonflye.config b/conf/test_hybrid_dragonflye.config index 669514d3..c163d945 100644 --- a/conf/test_hybrid_dragonflye.config +++ b/conf/test_hybrid_dragonflye.config @@ -23,8 +23,8 @@ params { input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_hybrid_dragonflye.tsv' // some extra args to speed tests up - assembly_type='hybrid' - assembler='dragonflye' - prokka_args=" --fast" - skip_kraken2 = true + assembly_type = 'hybrid' + assembler = 'dragonflye' + prokka_args = " --fast" + skip_kraken2 = true } diff --git a/conf/test_long.config b/conf/test_long.config index e722aae8..43eea8ad 100644 --- a/conf/test_long.config +++ b/conf/test_long.config @@ -23,8 +23,8 @@ params { input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_long_miniasm.tsv' // some extra args to speed tests up - prokka_args = " --fast" - assembly_type = 'long' - skip_polish = true - skip_kraken2 = true + prokka_args = " --fast" + assembly_type = 'long' + skip_polish = true + skip_kraken2 = true } diff --git a/conf/test_long_dragonflye.config b/conf/test_long_dragonflye.config index 304fb4d8..6007cff7 100644 --- a/conf/test_long_dragonflye.config +++ b/conf/test_long_dragonflye.config @@ -18,9 +18,9 @@ params { input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_long_miniasm.tsv' // some extra args to speed tests up - prokka_args = " --fast" - assembly_type = 'long' - assembler = 'dragonflye' - skip_kraken2 = true - skip_polish = true + prokka_args = " --fast" + assembly_type = 'long' + assembler = 'dragonflye' + skip_kraken2 = true + skip_polish = true } diff --git a/conf/test_long_miniasm.config b/conf/test_long_miniasm.config index 07af1a2c..8ae2d833 100644 --- a/conf/test_long_miniasm.config +++ b/conf/test_long_miniasm.config @@ -23,8 +23,8 @@ params { input = 'https://raw.githubusercontent.com/nf-core/test-datasets/bacass/bacass_long_miniasm.tsv' // some extra args to speed tests up - prokka_args = " --fast" - assembly_type = 'long' - assembler = 'miniasm' - kraken2db = "https://genome-idx.s3.amazonaws.com/kraken/16S_Greengenes13.5_20200326.tgz" + prokka_args = " --fast" + assembly_type = 'long' + assembler = 'miniasm' + kraken2db = "https://genome-idx.s3.amazonaws.com/kraken/16S_Greengenes13.5_20200326.tgz" } diff --git a/subworkflows/local/utils_nfcore_bacass_pipeline/main.nf b/subworkflows/local/utils_nfcore_bacass_pipeline/main.nf index df36a195..3d9063c4 100644 --- a/subworkflows/local/utils_nfcore_bacass_pipeline/main.nf +++ b/subworkflows/local/utils_nfcore_bacass_pipeline/main.nf @@ -75,7 +75,7 @@ workflow PIPELINE_INITIALISATION { // // Custom validation for pipeline parameters // - validateInputParameters() + //validateInputParameters() // // Create channel from input file provided through params.input @@ -151,7 +151,7 @@ workflow PIPELINE_COMPLETION { // Check and validate pipeline parameters // def validateInputParameters() { - genomeExistsError() + // Add functions here for parameters validation } // @@ -167,31 +167,6 @@ def validateInputSamplesheet(input) { return [ metas[0], fastqs, longread, fast5] } -// -// Get attribute from genome config file e.g. fasta -// -def getGenomeAttribute(attribute) { - if (params.genomes && params.genome && params.genomes.containsKey(params.genome)) { - if (params.genomes[ params.genome ].containsKey(attribute)) { - return params.genomes[ params.genome ][ attribute ] - } - } - return null -} - -// -// Exit pipeline if incorrect --genome key provided -// -def genomeExistsError() { - if (params.genomes && params.genome && !params.genomes.containsKey(params.genome)) { - def error_string = "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n" + - " Genome '${params.genome}' not found in any config files provided to the pipeline.\n" + - " Currently, the available genome keys are:\n" + - " ${params.genomes.keySet().join(", ")}\n" + - "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~" - error(error_string) - } -} // // Generate methods description for MultiQC From 820e7cfbfa5926cb6746f4079f33cd4d9322e4c4 Mon Sep 17 00:00:00 2001 From: Daniel VM <69470278+Daniel-VM@users.noreply.github.com> Date: Thu, 4 Apr 2024 09:29:56 +0200 Subject: [PATCH 3/3] Update .github/CONTRIBUTING.md in #124 Co-authored-by: Daniel Straub <42973691+d4straub@users.noreply.github.com> --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index de41a8e0..e96ce769 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -26,7 +26,7 @@ If you're not used to this workflow with git, you can start with some [docs from ## Tests -You have the option to test your changes locally by running the pipeline. +You have the option to test your changes locally by running the pipeline. For receiving warnings about process selectors and other `debug` information, it is recommended to use the debug profile. When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests. Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.