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

Change default branch back to main #176

Open
schuenke opened this issue Jun 6, 2024 · 5 comments
Open

Change default branch back to main #176

schuenke opened this issue Jun 6, 2024 · 5 comments

Comments

@schuenke
Copy link
Collaborator

schuenke commented Jun 6, 2024

I would suggest that we change the default branch back to main, as it is the case for >99% of all repositories I guess.

IMO it's also very confusing that our default branch and the PyPi version do not match. I would suggest to use main only for stable (released) versions and dev maybe as a general development branch where we merge all new features, fixes etc before they are combined into a new release, which is than merged to main and automatically published on PyPi (at least after #173 is live).

Simple 👍 or 👎 reactions are welcome 😀

@wtclarke
Copy link
Contributor

wtclarke commented Aug 8, 2024

I think ideally you don't have a dev branch, but a main and a branch for the current development stream with an appropriate name. E.g. v1.4.4 which would become version 1.4.4. This branch is then deleted once merged with main. The next version branch is then generated from main.

@schuenke
Copy link
Collaborator Author

I don't have the rights to do this change. Maybe @sravan953 can do it?

At this point we should also add a branch protection rule for main.
At least Require a pull request before merging and Require approvals should be enabled.
This can be done under Settings -> Branches -> Branch protection rules -> Add rule

@imr-framework
Copy link
Owner

I have created this ruleset (2 approvals required) and applied it to the master branch. The master branch is also the default branch now.

@schuenke
Copy link
Collaborator Author

schuenke commented Jan 8, 2025

thanks @imr-framework

I am not sure if 2 required approvals are a good idea. This would mean that we need at least 3 ppl working on / approving a PR. Not sure if this is realistic. IMO 1 approval from a maintainer is enough. When talking about maintainers: @fzimmermann89 and I will work together on the refactoring (see #95 and Slack discussions), so it would be great if he could approve PRs as well.

And in the meantime I would also disagree with my original suggestion to keep master / main (I actually prefer main!) in sync with PyPi, but would use master / main the same way we used dev in the past. Meaning: for each fix / feature etc we create a new branch and a PR against master / main.

On a regular basis, we create releases from master / main.

@imr-framework
Copy link
Owner

I've changed it to 1 approval, sorry for the delay!

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

No branches or pull requests

3 participants