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

[RFE] Docs need improvement how to actually build/test sysexts #94

Closed
fhemberger opened this issue Oct 10, 2024 · 0 comments
Closed

[RFE] Docs need improvement how to actually build/test sysexts #94

fhemberger opened this issue Oct 10, 2024 · 0 comments
Labels
kind/feature A feature request.

Comments

@fhemberger
Copy link
Contributor

fhemberger commented Oct 10, 2024

Current situation

Currently the README doesn't contain a description of the scripts contained in the repository and the necessary steps to build and test a single sysext or the complete set.

Impact

This situation adds an additional hurdle for submitting PRs for existing sysexts or creating new ones.

Ideal future situation

A section in the README listing the necessary prerequitises (environment, required packages/dependencies, etc.) and build examples along with a short description of the various scripts provided in the repository.

It should also include an example how to test and verify the function of a sysext (should also be a part of the release workflow).

@fhemberger fhemberger added the kind/feature A feature request. label Oct 10, 2024
fhemberger added a commit to fhemberger/sysext-bakery that referenced this issue Oct 10, 2024
fhemberger added a commit to fhemberger/sysext-bakery that referenced this issue Oct 21, 2024
tormath1 added a commit that referenced this issue Oct 21, 2024
README: Add sysext build instructions, fixes #94
darkspadez pushed a commit to darkspadez/sysext-bakery that referenced this issue Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature A feature request.
Projects
None yet
Development

No branches or pull requests

1 participant