Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: update guidelines to create module branches #541

Open
Lucia-Fonseca opened this issue Mar 29, 2022 · 3 comments
Open

DOC: update guidelines to create module branches #541

Lucia-Fonseca opened this issue Mar 29, 2022 · 3 comments
Labels
enhancement Improvement of existing feature

Comments

@Lucia-Fonseca
Copy link
Member

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 Lucia-Fonseca added the enhancement Improvement of existing feature label Mar 29, 2022
@rrjbca
Copy link
Contributor

rrjbca commented Mar 29, 2022

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
Copy link
Contributor

rrjbca commented Mar 30, 2022

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

@Lucia-Fonseca
Copy link
Member Author

Agreed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement of existing feature
Projects
None yet
Development

No branches or pull requests

2 participants