Added short workflow description

This commit is contained in:
Eddoursul 2021-10-06 19:09:49 +02:00
parent 3920b98e2c
commit da061b6456

View File

@ -23,11 +23,18 @@ The repository has three main branches:
- merging
- master
In short, the suggested workflow looks like this:
- commit your assets and ESP patches into `development`,
- merge and remove the ESPs in `merging`,
- forward `merging` into `master` and back into `development`.
Here is the process in detail.
All patches and assets must be committed to `development` and its sub-branches. ESP patches are allowed here. Keep in mind, other patches may interfere with your changes, you may want to test your patches in a separate sub-branch and merge it into `development` later.
The `development` branch is merged to `merging`, fully or through cherry-picking. ESP patches should be merged into ESMs here, English string files must also follow all changes.
Commits, having all ESPs merged in and removed from `merging`, can be merged from `merging` into `master`.
Commits, having all ESPs merged in and removed from `merging`, can be forwarded from `merging` into `master`.
Merging commits can be cherry-picked from `merging` back into `development`, removing merged in ESPs and updating ESMs without touching other patches.