Github branch policy

How to use the branches on github.

Create a new feature branch:

• open a new feature branch and branch out from existing feature branch.
• Write our code and push.
• Merge with the main feature branch, in necessary merge with the main or deployment branch.
• Close your branch.

Currently maintained branches

• main: main branch with new releases.
• deployment: main branch for the deployment on the server. <- Warning: All changes will be deployed immediately!
• design: main feature branch fpr design changes. <- Changes for the design go here!
• beta: main development branch to test new features on the beta server.
• search: feature branch for search.
• filter: feature branch for filtered search. Can be removed afterwards.
• scraping: feature branch for data scraping
• generators: feature branch to create django generators form jupyter notebooks or scripts.

Do's and dont's!

• Don't write your changes directly in the deployment branch. Branch out a feature branch, test and commit.
• Merge always working updates into main.
• Write your changes into the changelog.
• Create frequently releases and deploy releases on the server.
• Merge from main to deployment after a release.
• Test new features on beta.