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

[Feature Request] DX: Change the default branch of modularml/mojo from main to nightly #2556

Open
1 task done
gabrieldemarmiesse opened this issue May 6, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request mojo-repo Tag all issues with this label

Comments

@gabrieldemarmiesse
Copy link
Contributor

gabrieldemarmiesse commented May 6, 2024

Review Mojo's priorities

What is your request?

I would like a modularml admin to go to the settings of this repo and change the default branch to nightly, see https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch

What is your motivation for this change?

  • Many (mostly new) contributors make the mistake of targeting main instead of nightly. This happens so many times that we even had to make a github action to check it in the CI.
  • Also when reading contributing guides and such from the github UI, it makes sense that future contributors read the latest version (from nightly) than the latest stable version.
  • The mojo repo in the github UI is not supposed to be accessed by non-contributors (except the readme maybe), as such, it doesn't matter which version of the code/docs appears first in the github UI

To conclude: There is very little value in keeping main as the default branch, we could switch it to nightly.

This should lower the number of quirks to remember/learn when contributing to this repo.

Any other details?

No response

@gabrieldemarmiesse gabrieldemarmiesse added enhancement New feature or request mojo-repo Tag all issues with this label labels May 6, 2024
@gabrieldemarmiesse gabrieldemarmiesse changed the title [Feature Request] Change the default branch of modularml/mojo from main to nightly [Feature Request] DX: Change the default branch of modularml/mojo from main to nightly May 6, 2024
Copy link
Collaborator

Thanks for filing this. Would love the community to +1 if this is important to other folks. The reason that the main branch is is the default right now is to support the users that download the released versions of Mojo and want to run the examples.

@ematejska ematejska self-assigned this May 6, 2024
@gabrieldemarmiesse
Copy link
Contributor Author

gabrieldemarmiesse commented May 6, 2024

While this is in no way the exact list of all the PRs that have wrongfully targeted main, here is the list of PRs that target main and were not accepted after the stdlib became open source: https://github.com/modularml/mojo/pulls?q=is%3Apr+base%3Amain++is%3Aunmerged+created%3A%3E2024-03-28 . That can be used as a data point to understand the problem I'm talking about.

If we assume that https://github.com/modularml/mojo/pulls?q=is%3Apr+base%3Anightly+is%3Aclosed+created%3A%3E2024-03-28+-author%3AJoeLoser+ is the list of PR merged in nightly by the community, the number of PRs that targeted the wrong branch by the community is around ~10% of all opened PRs, which is significant.

If I may add, new contributors aren't necessarily the ones that will +1 this, because it's a mistake that contributors make once and will never make again. So it might not seem important when the contributor has learned that nightly is the right target.

Maybe there is something we can work out about the examples to still keep this workflow while still changing the main branch? If someone from the community has an idea there it would be great :)

@ematejska ematejska added mojo-repo Tag all issues with this label and removed mojo-repo Tag all issues with this label labels May 6, 2024
@jayzhan211
Copy link
Contributor

jayzhan211 commented May 8, 2024

+1 for this.

I would even prefer if the main branch is the current nightly branch for daily development. And, the stable branch is the current main branch for cutting release.

The reason that the main branch is is the default right now is to support the users that download the released versions of Mojo and want to run the examples.

Is it possible to redirect link to the release branch? If they jump into the repo instead of the official site, we can direct them with README.md

@ksandvik
Copy link

ksandvik commented May 20, 2024

Would it help if there was a cross-platform bash script or something similar with the right git instructions that did the right thing to set up fix branch locally?

@gabrieldemarmiesse
Copy link
Contributor Author

gabrieldemarmiesse commented May 21, 2024

Would it help if there was a cross-platform bash script or something similar with the right git instructions that did the right thing to set up fix branch locally?

I don't think the issue is here. The problem is in the github UI as mentionned in the issue description and a bash script won't change the UI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request mojo-repo Tag all issues with this label
Projects
None yet
Development

No branches or pull requests

4 participants