website icon indicating copy to clipboard operation
website copied to clipboard

Developer docs: contribution basics

Open sk-sahu opened this issue 4 years ago • 4 comments

Is your feature request related to a problem? Please describe. There were some confusions from where to checkout from, like master and dev. For new people this might be difficult, and they only realise they should raise PR against dev once they reach the PR checklist

A scenario from today in slack - https://nfcore.slack.com/archives/C01QPMKBYNR/p1616421940076700

Describe the solution you'd like Some small workflow how to start -

For new a existing repo to make changes -

  • make a fork of your own
  • dev is the latest branch, so always checkout from here
  • edit and commit
  • PR against dev branch in main repo

sk-sahu avatar Mar 22 '21 15:03 sk-sahu

I'm afraid that this is not possible. We want the default branch to be master because that's what Nextflow pulls if you don't specify a release, so it should be the latest stable release. There is no way to have repos fork / PR to a different branch than the default.

This is already in the docs, the tutorials, the training talks (contributions for beginners) and the contribution guidelines for all repos. We also have automated tests to stop PRs being opened against master with beginner-friendly automated comments explaining the failure. So we've basically already done everything that I can think of 😅

Shout if you have suggestions for anything else that we could do though 👍

ewels avatar Apr 01 '21 18:04 ewels

Ah sorry, I think I misunderstood the point of your issue. More docs for this could be good, yes 👍

Basically a written version of the talks we've given would be good I guess. Could also take from the contribution guidelines docs.

ewels avatar Apr 01 '21 18:04 ewels

Hi @gregorysprenger, if you tell me the PR number here, I can see to this getting a review. It's always good to have issues and PRs connected, for example by commenting in the PR "fixes issue #xxx". Read also here

FranBonath avatar Mar 29 '23 07:03 FranBonath

Whoops, I apologize. I only mentioned it in the title of the PR and not the comment. The PR is https://github.com/nf-core/nf-co.re/pull/1714

gregorysprenger avatar Mar 29 '23 12:03 gregorysprenger