move git branches to its own article authored by Malin Freeborn's avatar Malin Freeborn
# Say 'Hi' # Introduction
There's a chatroom in Matrix. - [How to Pitch In](join/Pitching-In)
- [Why the Printing?](join/PIY)
- [Chatroom](https://matrix.to/#/#bindrpg:matrix.org) - [Why the GPL?](join/Licensing)
- [How the workflow goes](join/Workflows)
## Workflow ## Workflow
If you're new to `git`, then:
1. [compile the repo](dev/Compiling), and
1. try out the [basic git](dev/Basic-Git) commands.
The workflow broadly goes like this:
- Small changes go into the `dev` branch.
- Big changes go into a branch, then into the `dev` branch once they're ready.
- Merging into the `master` branch always requires a manual review.
```mermaid
---
title: Current Git Workflow
---
%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': 'master'}} }%%
gitGraph
commit
branch dev
commit
branch run
checkout dev
commit
commit
branch skills
checkout skills
commit
commit
checkout dev
commit
branch img
commit
checkout dev
commit
checkout run
merge skills
merge dev
checkout skills
commit
checkout dev
merge skills
checkout master
merge dev
```
### Branches overview:
- `master` requires a manual formatting check, because LaTeX isn't reliable. Once something goes to the master branch, it gets published automatically.
- `dev` functions like a master branch, but without the formatting checks. Everything here will eventually go into the master branch.
- `run` only exists to test a pipeline. Anything you put here may be destroyed at any moment with a forced push.
- `img` branches allow images to get a double check before entering the git history. All images have to meet certain [standards](dev/Image-Requirements).
- `ods` only exists to update the Character Spreadsheet for online play. This is seriously out-of-date, and I will probably just delete that ods file soon, because BIND does not work well with online games.
- `l10n-de` is a [German translation](dev/German-Translation).
- Anything else goes in its own branch.
### General Structure ### General Structure
- **Modules**: each module should get a tiny summary of the rules - just enough to play if the Judge feels okay making some rulings on the fly. - **Modules**: each module should get a tiny summary of the rules - just enough to play if the Judge feels okay making some rulings on the fly.
...@@ -111,8 +56,9 @@ Notes on the game's design. ...@@ -111,8 +56,9 @@ Notes on the game's design.
A quick-start guide to Latex and notes on how the books are laid out: A quick-start guide to Latex and notes on how the books are laid out:
- [Starting with Latex](dev/Compiling) - [Starting with Latex](dev/Compiling)
- [Starting with Git](dev/Basic-Git)
- [Repo Overview](dev/Format) - [Repo Overview](dev/Format)
- [Starting with Git](dev/Basic-Git)
- [Git Branching](dev/Git-Branches)
## Development ## Development
... ...
......