Init CONTRIBUTING.md
Explain how to get changes into the existing branches of this repo and what the branches are for
This commit is contained in:
parent
fd7f326376
commit
879a657f8c
27
CONTRIBUTING.md
Normal file
27
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# Quick branch overview
|
||||
We work with several branches in this repo. This document aims to explain how
|
||||
to contribute changes to the existing branches.
|
||||
|
||||
### `main` branch
|
||||
- Changes to `modules` and `profiles` should go [the main branch](https://git.pub.solar/pub-solar/os/src/branch/main)
|
||||
- Changes can get accepted via: Pull Request
|
||||
- Branch protected from direct `git push`
|
||||
|
||||
### `infra` branch
|
||||
- Changes to the [pub.solar](https://pub.solar) infrastructure should be merged [into this branch](https://git.pub.solar/pub-solar/os/src/branch/infra)
|
||||
- Changes can get accepted via: Pull Request
|
||||
- Branch protected from direct `git push`
|
||||
|
||||
### `momo/main` branch
|
||||
- Changes to the [Momo](https://momo.koeln) infrastructure should be merged [into this branch](https://git.pub.solar/pub-solar/os/src/branch/momo/main)
|
||||
- Changes can get accepted via: Pull Request
|
||||
- Branch protected from direct `git push`
|
||||
|
||||
### `$USER` branches
|
||||
- User's custom hosts and changes can be worked on in these branches
|
||||
- Direct `git push` possible
|
||||
- Examples:
|
||||
- [hensoko](https://git.pub.solar/pub-solar/os/src/branch/hensoko)
|
||||
- [b12f](https://git.pub.solar/pub-solar/os/src/branch/b12f)
|
||||
- [axeman](https://git.pub.solar/pub-solar/os/src/branch/axeman)
|
||||
- [teutat3s](https://git.pub.solar/pub-solar/os/src/branch/teutat3s)
|
Loading…
Reference in a new issue