dentproject / feature

Public repository for the DENT Project Roadmap and Feature Working Group.
1 stars 0 forks source link

New feature description template #47

Open jmpolom opened 2 years ago

jmpolom commented 2 years ago

Need to determine rough content needs for this. Is template from dentOS sufficient?

Overview Describe the feature and what it should do. This should be at least one sentence and may be several. Preferably, this is not a bullet point list but rather a verbose description of the thing.

Use Case Succinctly describe how the feature will be used. Providing a sense of scale (instances of this feature) and performance requirements would be helpful. One or two sentences should be adequate.

Operation

Testing Optionally, explain how this feature could be tested, what a preferred test method may be or who will write the test case.

Kernel support Does this feature depend on in kernel support? Can the feature be supported natively by the upstream (IE: kernel.org) Linux kernel and associated utilities like iproute2, ethtool or similar? Would changes to kernel space facilities be necessary to add this feature?

Other upstream support Could the feature be integrated into an existing upstream piece of user space software such as systemd, ISC DHCP daemon/client, FRR, etc.? If so which upstream utility seems like the best fit and why? Is there any prior art upstream?

taraschornyiplv commented 2 years ago

I'd recommend to add a question Is this feature supported by "standard Linux" means can we have requested feature working on server with bunch of NICs

jmpolom commented 2 years ago

@taraschornyiplv I've updated my original post with a section about kernel and upstream user space support. I think this addresses your comment. Late, I know, but better than never.

I'd like to review this issue and unless there are objections, have his finalized by our next meeting on 24 March.

cc: @lperkov @Mickey201 @snobleaws @sonoble

Mickey201 commented 2 years ago

As I won't be able to join the upcoming meeting; @jmpolom, I went over the template and I found it very well. No comments from my side.