tetragon icon indicating copy to clipboard operation
tetragon copied to clipboard

Add a PR template to this repo

Open sadath-12 opened this issue 1 year ago • 2 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Is your feature request related to a problem?

No response

Describe the feature you would like

Consider adding a pr template that motivates the contributer to give sufficient information on the work he has done on that pr so anyone could get the proper context on that pr

Describe your proposed solution

No response

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

sadath-12 avatar Jan 04 '24 06:01 sadath-12

It would be very useful to add a PR template indeed.

I think it can be inspired by the Cilium PR template, maybe a bit simpler. Things that should be mentioned IMO:

  • tests (link do dev docs how to run them?)
  • commit subject, body and sign-off (link to the Cilium dev docs?)
  • release note (if PR title is not enough)
  • add yourself to users (in cilium/cilium repo,this one doesn't have USERS.md yet)

@paularah Any thoughts here?

lambdanis avatar Mar 18 '24 14:03 lambdanis

Indeed it'd be useful. We should be have the USERS.md file in soon, once we've gathered the info we need from users. @sadath-12 Feel free to open PR if you'd love to take a stab at this.

paularah avatar Mar 19 '24 11:03 paularah