github.com/cilium/ebpf@v0.16.0/docs/ebpf/contributing/new-example.md (about)

     1  # Adding a new example
     2  
     3  The library includes some examples to make getting started easier.
     4  The aim of the examples is to __show how the library works, not how to implement a specific thing in eBPF__.
     5  This is because the scope of eBPF is simply too large for us to cover.
     6  
     7  Please consider the following before proposing a new example:
     8  
     9  1. What feature __of the library__ does it showcase?
    10  2. Is there already an existing example for that feature? If yes, could it be extended without making it harder to understand?
    11  3. How complicated is the eBPF code required to make it work? How could the amount of eBPF be minimised?
    12  
    13  Please contact the maintainers on Slack if you are in doubt about any of
    14  these points.
    15  
    16  ## What makes a good example?
    17  
    18  * It should be concise. The less code the better.
    19  * It should show a single thing. The less configurable the better.
    20  * It should be well documented. Even a novice user must be able to follow
    21    along.
    22  * It should produce meaningful output or have an easily testable effect.
    23  * It should have as few requirements on software / hardware as possible.