particle-os/debian-forge-composer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: Add osbuild-composer's principles

Browse source
This commit is contained in:
Simon Steinbeiss 2024-02-27 00:34:29 +01:00 • committed by Ondřej Budai
parent 484c82ce55
commit 006c7a6742
1 changed files with 16 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -17,17 +17,28 @@ instance, includes a
[Cockpit Module](https://github.com/osbuild/cockpit-composer) or using the
[composer-cli](https://weldr.io/lorax/composer-cli.html) command-line tool.
### Project
## Project
* **Website**: <https://www.osbuild.org>
* **Bug Tracker**: <https://github.com/osbuild/osbuild-composer/issues>
* **matrix**: https://matrix.to/#/#image-builder:fedoraproject.org
* **Mailing List**: image-builder@redhat.com
* **Matrix**: https://matrix.to/#/#image-builder:fedoraproject.org
* **Mailing List**: image-builder@redhat.com
* **Changelog**: <https://github.com/osbuild/osbuild-composer/releases>
#### Contributing
### Principles
Please refer to the [developer guide](https://www.osbuild.org/docs/developer-guide/index/) to learn about our workflow, code style and more.
1. OSBuild Composer shall only allow users to do what generally makes sense.
2. Blueprints are the policy layer where we decide what to expose to end users.
3. If a blueprint can be built, it should also boot.
4. It should be obvious why a blueprint doesn’t build.
5. The [cloud API](./internal/cloudapi) is never broken.
6. In the hosted service, OSBuild Composer is an orchestrator of image builds.
7. On-premises, it should be as easy as possible to run the service and build an image.
8. OSBuild Composer needs to run on the oldest supported target distribution.
### Contributing
Please refer to the [developer guide](https://osbuild.org/docs/developer-guide/index) to learn about our workflow, code style and more.
### About