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

Rework branch structure #6

Open
zbrachinara opened this issue Jul 10, 2022 · 3 comments
Open

Rework branch structure #6

zbrachinara opened this issue Jul 10, 2022 · 3 comments
Labels
wontfix This will not be worked on

Comments

@zbrachinara
Copy link
Member

This fork has very disorganized branches. There are lots of branches in this repo whose purpose is unknown, and/or has been left as a temporary branch and never cleaned up. There are also other branches which may be archival, but whose name does not suggest this.

A system which replaces the current one must satisfy the following conditions:

  • leaves minimal change on the master branch
  • documents itself, preferably on the master branch
  • Allows archiving of code from past seasons, along with the version of evlib used last by that season
  • have a naming scheme which makes the purpose of the branch obvious

Refactoring of the branches currently in the repo is left open for now.

@zbrachinara
Copy link
Member Author

Here's a potential solution:

  • master: only has upstream code and an additional github actions file
  • evlib-dev: used for active evlib development. Everything except for the TeamCode module can be modified
  • evlib-release: used only for verified and ready features of evlib
  • season-[year]-[name]: used for active in-season development. It receives updates from evlib-release, and only TeamCode can be modified.

Because the directories in the season branches and the evlib-release branch are exclusive of each other, merge conflicts should be much less common. The branches are also easily searchable, since they are prefixed by their category.

This doesn't address the location of the branch documentation though. And related to the point on searchability, perhaps the name should come before the year on the season branches?

@icanc0
Copy link

icanc0 commented Jul 12, 2022

zamn!! that's a great idea!!!

@zbrachinara
Copy link
Member Author

Been a while, last few tasks are to preserve the old branches somewhere and delete them from this repo

@robot256 robot256 added this to the Off Season 2023 milestone Feb 24, 2023
@robot256 robot256 added the wontfix This will not be worked on label Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

3 participants