From 330e3306d24acabfa90dfcc7b27472ee01ca55e4 Mon Sep 17 00:00:00 2001 From: mauvehed Date: Thu, 5 Dec 2024 22:21:17 -0600 Subject: [PATCH] docs(DEVELOPERS.md): add branch strategy section to guide development workflow Introduce a branch strategy section to the developer documentation, detailing the use of a Git and GitHub Flow variation. This addition provides clear instructions for creating and managing branches, making changes, and merging them. It aims to standardize the development process, ensuring consistency and clarity for both developers and maintainers. This helps in maintaining a clean and organized codebase and facilitates smoother collaboration. --- docs/DEVELOPERS.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/docs/DEVELOPERS.md b/docs/DEVELOPERS.md index 25b5821..fadf8de 100644 --- a/docs/DEVELOPERS.md +++ b/docs/DEVELOPERS.md @@ -73,3 +73,57 @@ bun run preview ``` Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. + +## Branch Strategy + +We use a simple variation of Git and GitHub Flow for branch control. + +### Create and switch to a develop branch + +```bash +git checkout -b develop +``` + +#### Create a feature branch from develop + +```bash +git checkout -b feature-branch develop +``` + +#### Make changes and commit + +```bash +git add . + +git commit -m "Implement new feature" +``` + +### Developers + +Submit a PR to merge your feature changes to the `develop` branch + +### Maintainers + +#### Merge feature branch back to develop + +```bash +git checkout develop + +git merge feature-branch +``` + +#### When ready for release, merge develop to master + +```bash +git checkout master + +git merge develop +``` + +### Tag the release + +```bash +git tag -a v1.0 -m "Release version 1.0" + +git push origin v1.0 +```