theupdateframework / theupdateframework/python-tuf
switch to main branch?
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 304
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 17
Description
The use of "develop" as the default branch is annoying and probably makes life hard for new contributors. We already know switching is not that hard from securesystemslib, so I think we could switch to "main":
- Update any GH workflows that refer to "develop" branch, update any docs mentioning "develop"
- change branch related options in GH settings (branch protection rules, Pages, ...)
- change default branch in GH settings
- delete develop branch on GH (so that people notice that the branch is missing instead of staying on a stale branch)
- check that tuf-conformance uses correct branch to get conformance results
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the GitHub workflows and documentation for references to the develop branch, then inspect the repository's branch, protection, Pages, and default-branch settings. Check how tuf-conformance selects its branch and verify that it uses main. Done means all references and settings are updated, develop is deleted, and conformance results still work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, github-actions, python
- Domain
- ci-cd, developer-experience, devops
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100