pub-solar-os/CONTRIBUTING.md

# 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
- Deployment of changes is [automatic via CI pipeline](https://git.pub.solar/pub-solar/os/src/commit/43bd7421509f7cc9ba06d7c740f3f536a4a2af76/.drone.yml#L20-L38)
- 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)
Init CONTRIBUTING.md Explain how to get changes into the existing branches of this repo and what the branches are for 2023-03-28 12:20:58 +00:00			`# Quick branch overview`
fix: move pre-commit treefmt hook into CI The logic inside the hook was rather broken, causing confusing merges, stashes, and aborts. Unfortunately `treefmt` does not provide a pure lint option that checks without writing the changes. So instead, we do this in CI. 2023-07-13 14:59:22 +00:00
Init CONTRIBUTING.md Explain how to get changes into the existing branches of this repo and what the branches are for 2023-03-28 12:20:58 +00:00			`We work with several branches in this repo. This document aims to explain how`
			`to contribute changes to the existing branches.`

			### `main` branch
fix: move pre-commit treefmt hook into CI The logic inside the hook was rather broken, causing confusing merges, stashes, and aborts. Unfortunately `treefmt` does not provide a pure lint option that checks without writing the changes. So instead, we do this in CI. 2023-07-13 14:59:22 +00:00
Init CONTRIBUTING.md Explain how to get changes into the existing branches of this repo and what the branches are for 2023-03-28 12:20:58 +00:00			- 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
fix: move pre-commit treefmt hook into CI The logic inside the hook was rather broken, causing confusing merges, stashes, and aborts. Unfortunately `treefmt` does not provide a pure lint option that checks without writing the changes. So instead, we do this in CI. 2023-07-13 14:59:22 +00:00
Init CONTRIBUTING.md Explain how to get changes into the existing branches of this repo and what the branches are for 2023-03-28 12:20:58 +00:00			`- 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
fix: move pre-commit treefmt hook into CI The logic inside the hook was rather broken, causing confusing merges, stashes, and aborts. Unfortunately `treefmt` does not provide a pure lint option that checks without writing the changes. So instead, we do this in CI. 2023-07-13 14:59:22 +00:00
Init CONTRIBUTING.md Explain how to get changes into the existing branches of this repo and what the branches are for 2023-03-28 12:20:58 +00:00			`- 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`
docs: mention ci deployment for momo/main branch 2023-03-28 12:31:48 +00:00			`- Deployment of changes is [automatic via CI pipeline](https://git.pub.solar/pub-solar/os/src/commit/43bd7421509f7cc9ba06d7c740f3f536a4a2af76/.drone.yml#L20-L38)`
Init CONTRIBUTING.md Explain how to get changes into the existing branches of this repo and what the branches are for 2023-03-28 12:20:58 +00:00			- Branch protected from direct `git push`

			### `$USER` branches
fix: move pre-commit treefmt hook into CI The logic inside the hook was rather broken, causing confusing merges, stashes, and aborts. Unfortunately `treefmt` does not provide a pure lint option that checks without writing the changes. So instead, we do this in CI. 2023-07-13 14:59:22 +00:00
Init CONTRIBUTING.md Explain how to get changes into the existing branches of this repo and what the branches are for 2023-03-28 12:20:58 +00:00			`- User's custom hosts and changes can be worked on in these branches`
			- Direct `git push` possible
			`- Examples:`
fix: move pre-commit treefmt hook into CI The logic inside the hook was rather broken, causing confusing merges, stashes, and aborts. Unfortunately `treefmt` does not provide a pure lint option that checks without writing the changes. So instead, we do this in CI. 2023-07-13 14:59:22 +00:00			`- [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)`