README: link to docs/developer in Contributing section #959
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
schuellerf
approved these changes
Sep 30, 2024
achilleas-k
force-pushed
the
local-dev-docs-link
branch
from
0eadc36 to
36bc2d6
Compare
The section links to the general osbuild team developer guide, but the local developer documentation is also very useful. The page is already linked from the HACKING.md file, but that could be missed by someone focusing on the README and following the link to osbuild.org.
bcl
force-pushed
the
local-dev-docs-link
branch
from
36bc2d6 to
07a07e5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The section links to the general osbuild team developer guide, but the local developer documentation is also very useful. The page is already linked from the HACKING.md file, but that could be missed by someone focusing on the README and following the link to osbuild.org.
Sidenote: We need to document the
btrfs-progs-develanddevice-mapper-develdependencies better. They're not required for building the binaries or running the tests. They're only needed when using local container storage, which we don't test in our unit tests (or our integration tests, for that matter). So maybe we should also be testing that here instead of relying on bootc-image-builder and osbuild-composer.