workflow for content and development changes

[MartinSchott]

• [x] #231

• main branch

  • only stable tech developments, only reviewed content.
  • This branch is online! (rendered website)

• dev branch (development)

  • reviewed and managed by @bmen
  • only technical and design changes
  • NO working on content!

• content branch

  • reviewed by Sara, managed by repo maintainers
  • for reviewing and quality control

Workflow

content publishing

• new content is added in content branch, e.g.
  • new profile: issue is created, LEAD maintainer/developer transfers it to profile file
  • new text for a page (e.g. "about" page) is committed by LEAD developers into content branch
• pull request (with template?) is created from content to main branch by LEAD maintainers/developers
• before publishing content in the main branch, the pull request from the content branch will be reviewed by Sara

tech and design changes

• new design changes or features are added to the dev branch (primarily by @bmen , also others in the future)
• new content is pulled from the main branch into the dev branch
• merge conflicts will be solved locally (meaning on the computer of the developer)
• pull request is created from dev to main, containing both the published content AND the tech/design changes

[timmwille]

Release Workflow

Prep:

• create dev & content branch from main

Process:

1. • content → main Review check [Sara] & merge (no conflicts) [maintainer]
2. • Release [maintainer]
3. • dev → main Review check & merge (conflicts!) [@bmen] + maintainer
4. • dev → content merge (conflicts!) always first then content → main Pull Request [@bmen] (automatic?)
5. loop

[bmen]

Git workflow diagram

[timmwille]

nice @bmen add the optimised picture as well, I Like it

[timmwille]

where would we document this, Wiki? @MartinSchott

[MartinSchott]

@timmwille I created a first version here: https://github.com/ASKnetCommunity/ASKnet.Community/wiki/Git-Workflow can you check it?

feel free to check it as well @bmen

[timmwille]

@bmen → as you mentioned we rather change the graphic/process to: PR from develop → main and → content simultaneously!

@MartinSchott might be best to update the wiki text for the website as well?

[bmen]

@bmen → as you mentioned we rather change the graphic/process to: PR from develop → main and → content simultaneously!

changed info graphic :heavy_check_mark:

[timmwille]

@bmen → as you mentioned we rather change the graphic/process to: PR from develop → main and → content simultaneously!

changed info graphic heavy_check_mark

Hmm https://github.com/ASKnetCommunity/ASKnet.Community/wiki/Git-Workflow looks a little bit unclear to me, do you have the svg here to upload so we can look into it later?

[timmwille]

It would be great to visualize in this way:

[MartinSchott]

@bmen can you change the picture? Or if you send me a link to where you do these graphics, I could also change it

[timmwille]

current version here: https://github.com/ASKnetCommunity/ASKnet.Community/wiki/Git-Workflow

[MartinSchott]

todo:

• [x] put link to the above wiki link to LEAD Wiki

[timmwille]

might be a new approach but I think we still need a development branch. What do you think @DutKulang

this is where the Idea came from: https://nvie.com/posts/a-successful-git-branching-model/

[timmwille]

this is already done via main Wiki right?

https://github.com/ASKnetCommunity/ASKnet.Community/wiki/Git-Workflow

[bmen]

it's documented how @timmwille said. I close this issue