search

Sage-Bionetworks / challengescoring

This R package provides scoring mechanisms for computational challenges and implements the bayesBootLadderBoot approach for avoiding test data leakage.
Apache License 2.0
3 stars 0 forks source link

Document the reason why develop branch is the default branch #17

Closed thomasyu888 closed 4 years ago

thomasyu888 commented 4 years ago

Potentially switch back to master so we actually have a develop branch to do release cycles.

allaway commented 4 years ago

Develop is the default branch so that contributors will PR against that by default, and not master. Master is for release cycles. It's the same model used in the sage synapseAnnotations repository.

thomasyu888 commented 4 years ago

Ahh. Interesting! I think it's fine that the develop branch is public facing / the default branch that people get when they do git clone ...

Ive always had master be the default with added branch protection so no one can push to it by accident. We should just add documentation for people that do install the repo by source that the default is develop.

allaway commented 4 years ago

Yep! Ideally, we would have this in the README (not there yet, obviously):

To install this package, run the following R command: 

remotes::install_github("Sage-Bionetworks/challengescoring@master")

This way people using the package will get the most recent release, but people working on the repo (i.e. actually cloning the repo - packages users shouldn't and won't need to do this) will be developing on the most recent changes to develop, not master.

thomasyu888 commented 4 years ago

Renamed the issue. Thanks @allaway :)