did a lot of work restructuring our GitHub repo and teaching the rest of the team how we will use branches
this is the message i sent them:
I’m changing the way we use GitHub just a bit so things are easier.
This is similar to how teams usually use Github.
There are 3 types of branches:
-
release: the live, released version on CF and Modrinth -
develop: the next version we’re building -
feature/[feature-name]: where new features are built, where you do your work, make sure everything in it is related to the feature you are adding
release
this is the official released code
everything here should be stable and working
we only update this when we release a new version
develop
this is where all completed features go
it is the next version of the mod
it should mostly work, may have minor issues
feature/*
when you work on a new feature, you create a branch like: feature/concher, feature/bulltoad, etc.
when you create a feature branch, it should always branch from develop
each branch = one feature, keep it focused and short
Workflow
- Start a feature: create a feature branch
feature/[feature-name] - Work on it: make commits as you go, push to your feature branch
- Finish the feature: open a pull request into
develop - After merging, delete the feature branch
When we release a new version, we will merge develop into release and create a version tag.
Important Rules
- don’t commit directly to
release - don’t commit directly to
developunless its a small fix that doesn’t deserve its own feature branch - always branch from
develop - if your feature branch gets outdated, merge
developinto it
i also pulled the newest release version commits into all of the feature branches
Log in to leave a comment