Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add page describing current branching policies #76

Open
Pinolo opened this issue Sep 2, 2020 · 3 comments
Open

Add page describing current branching policies #76

Pinolo opened this issue Sep 2, 2020 · 3 comments

Comments

@Pinolo
Copy link
Contributor

Pinolo commented Sep 2, 2020

In "procedures" or "guides" section?

Information should reflect what has been done in https://gitlab.sparkfabrik.com/sparkfabrik-innovation-team/board/-/issues/108 (only accessible by SF staff), and any other relevant information about common branching policies, associated with CI/CD

@stickgrinder
Copy link
Member

Guides section is for broader treatment of a topic, while Procedures contains basically "checklists and recipes" that you can follow top-to-bottom.

A good example for disambiguation is:

Can you spot the difference?

@Pinolo
Copy link
Contributor Author

Pinolo commented Sep 2, 2020

It looks more "guides" to me. What do you think?

@stickgrinder
Copy link
Member

If it is supposed to be a rule that we MUST implement, having at least a short companion procedure to set things up (or a checklist to refer to) is a boon.

If it is an informative page, helping people finding a common ground and then things may evolve from there freely (like it should be in a dynamic env) a guide is ok.

Mind that we already have a page related to git procedures: https://playbook.sparkfabrik.com/procedures/git-rebase-workflow
This is obviously a sub-subset of the topic but you may want to take this into consideration and possibly integrate it with the guide or create other procedures to complete this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants