website icon indicating copy to clipboard operation
website copied to clipboard

nf-core contributing overview tutorial update

Open christopher-hakkaart opened this issue 2 years ago • 7 comments

This tutorial is generally really good. It was last updated in March 2022. It's been a massive year with new some tooling absent from this material.

  • [x] Remove reference to atom in linting
  • [x] Add a section about prettier and black after linting
  • [ ] Add a section about subworkflows
  • [ ] Update how to join nf-core the GitHub org in exercise 5 to direct everyone to Slack

christopher-hakkaart avatar Mar 09 '23 13:03 christopher-hakkaart

Hej @Furentsu and @GerardoAcquaviva, do you happen to have a PR number for the changes you made to solve this issue?

FranBonath avatar Mar 28 '23 15:03 FranBonath

Hi, we actually made two different PRs.

Furentsu avatar Mar 28 '23 16:03 Furentsu

I don't understand why prettier check works locally, but it fails here on github...my pull request is #1708

Furentsu avatar Mar 29 '23 07:03 Furentsu

it seems prettier has passed for this PR? In the beginning we had issues with having enough resources, so prettier failed on github. Maybe that was the problem here, too.

FranBonath avatar Mar 29 '23 07:03 FranBonath

Right, but it doesn't seem to be able to merge my pull request somehow..

https://github.com/nf-core/nf-co.re/actions/runs/4544320764

Furentsu avatar Mar 29 '23 07:03 Furentsu

I see. Maybe @ewels can have a look at that?

FranBonath avatar Mar 29 '23 07:03 FranBonath

The PR appears to be merged already?

I can see what look like quite a few markdown errors in the diff though (by eye). Also I think the content needs some tweaking - we should mention Prettier instead of markdownlint (we switched tools a while back) and I don't think that we should talk about configuring black. We want everyone to use the same config, not mess with it 😬

ewels avatar Mar 29 '23 08:03 ewels