skypy icon indicating copy to clipboard operation
skypy copied to clipboard

DOC: update guidelines to create module branches

Open Lucia-Fonseca opened this issue 2 years ago • 3 comments

Description

The contributing guidelines should be updated to reflect how to create a new module branch. Example:

git checkout -b module/module_name main

And when first pushed

git push --set-upstream origin module/module_name

Lucia-Fonseca avatar Mar 29 '22 14:03 Lucia-Fonseca

IMO creating and maintaining module branches is a matter for coordinators and/or repo maintainers and so so should not be in contributor guidelines. In fact the branch protection rules will not allow non-admins to create branches in the way you suggest. Perhaps a new doc "maintainer guidelines" is needed outlining tasks specifically for maintainers such as this, creating releases etc.

What I do think needs to be in the contributor docs is a sentence to the effect of "If you are making a contribution to a new module that has not yet been merged into the main branch, you should set the target branch of your pull request to the appropriate module branch instead of main"

rrjbca avatar Mar 29 '22 14:03 rrjbca

Perhaps also guidelines on what to do if you want to propose a new module (in discussion pages?)

rrjbca avatar Mar 30 '22 09:03 rrjbca

Agreed.

Lucia-Fonseca avatar Mar 30 '22 14:03 Lucia-Fonseca