Hello linting experts :slightly_smiling_face: I ha...
# linting
l
Hello linting experts 🙂 I have a question concerning the CONTRIBUTING.md file: is there any way to change it without upsetting the linting or that file is supposed to be untouched?
p
I guess it's supposed to be untouched 🤔 What is it that you'd like to change?
l
It was mostly for this comment in my PR https://github.com/nf-core/multiplesequencealign/pull/158#discussion_r1781256537 I have a section in which I explain precisely how to extend the pipeline, and i was suggested to move it to contributing
p
Nice! There are four possible paths here, from easy to complex: 1. Ignore Maxime and leave it where it is 2. Ignore the linting test: https://nf-co.re/docs/nf-core-tools/pipelines/lint#linting-config (see example for
files_unchanged
) 3. Update the lint test to allow the changelog to have additional content appended to the end (requires a release of #CE5LG7WMB, also means your content will be underneath the template contributing docs) 4. Rework both files and generalise / merge the content (requires tools release)
Personally I'd probably do something like, leave it where it is but add a big note to the top of the contributing docs saying that there is pipeline-specific contributing docs as well, with a link. Then ignore the lint test to allow that to be there.
l
Perfect, thanks! I think i'll do that 🙂
👍🏻 1