Update usage info

[mahesh-panchal]

Updates suggestion for writing custom configuration.

PR checklist

• This comment contains a description of changes (with reason)
• CHANGELOG.md is updated
• If you've fixed a bug or added code that should be tested, add tests!
• Documentation in docs is updated

[mashehu]

Is it possible that you don't have the latest version of yamllint.yml? Because the template linting errors were fixed in the latest version.

[mahesh-panchal]

I don't know what's going on with the yaml linting there. I merged dev on my fork, opened up a Gitpod, made the change, and made the pull request.

[mashehu]

yeah, yamllint inside the gitpod is fine... weird.

[mashehu]

Oh, the yamllint we use inside github actions comes from npm and uses a different config file than the conda yamllint 🤦🏻 (especially, it has to be called yaml-lint.json). A simple fix would be to add a --ignore ./nf-core/template*/ to the command in the github workflow.

[github-actions]

YAML linting is failing

To keep the code consistent with lots of contributors, we run automated code consistency checks.
To fix this CI test, please run:

• Install yaml-lint
  • Install npm then install yaml-lint (npm install -g yaml-lint)
• Fix the markdown errors
  • Run the test locally: yamllint $(find . -type f -name "*.yml" -o -name "*.yaml") -c ./.yamllint.yml
  • Fix any reported errors in your YAML files

Once you push these changes the test should pass, and you can hide this comment 👍

We highly recommend setting up yaml-lint in your code editor so that this formatting is done automatically on save. Ask about it on Slack for help!

Thanks again for your contribution!