bpfman

bpfman copied to clipboard

docs: Add issue reporting instructions to README.md

1

The README.md should explain how to report issues to the project. At present, we recommend using GitHub Issues or a GitHub Discussion.

dave-tucker

Something similar to https://github.com/ovn-kubernetes/ovn-kubernetes/blob/master/ADOPTERS.md Would be nice as well to link this to the `mkdocs.yml` in the same way that we re-use the governance documentation. The only adopter(s) so far...

dave-tucker

Probably somewhere int the `Community` section would be great We're on kubernetes Slack: https://kubernetes.slack.com/archives/C04UJBW2553 To join K8s slack: https://slack.k8s.io/

dave-tucker

CI is monolithic right now. It would be better to break down what we have into [re-useable workflows](https://docs.github.com/en/actions/sharing-automations/reusing-workflows) This will allow us to use composition to create CI workflows in...

dave-tucker

Example: https://github.com/sustainable-computing-io/kepler/blob/main/.github/workflows/pre-commit.yml This allows us to remove a lot of the individual steps within our main CI workflow.

dave-tucker

See this workflow as an example: https://github.com/sustainable-computing-io/kepler/blob/main/.github/workflows/pre-commit-auto-update.yml

dave-tucker

Example: https://github.com/sustainable-computing-io/kepler/blob/main/.pre-commit-config.yaml#L19-L22

dave-tucker

For example: https://github.com/sustainable-computing-io/kepler/blob/main/.pre-commit-config.yaml#L4-L9

dave-tucker

See: https://github.com/bpfman/bpfman/blob/main/.github/workflows/build.yml#L137-L140 Example: https://github.com/sustainable-computing-io/kepler/blob/main/.pre-commit-config.yaml#L14-L18

dave-tucker

Add a pre-commit hook that runs `taplo fmt --check`. See also: https://bpfman.io/v0.5.6/getting-started/building-bpfman/#install-toml-formatter

dave-tucker