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

Add README.md and template #2

Merged
merged 1 commit into from
Feb 23, 2023
Merged

Add README.md and template #2

merged 1 commit into from
Feb 23, 2023

Conversation

xmulligan
Copy link
Member

@xmulligan xmulligan commented Feb 16, 2023

Something terrrible happened in Git in #1

As discussed in the January 25th community meeting and cilium/cilium#23690, this folder will let us keep track of CFP for future design discussions.

@xmulligan xmulligan changed the title Add README.md and temaplte Add README.md and template Feb 16, 2023
Copy link
Contributor

@youngnick youngnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good to me, just want to clarify how the flow with CFP numbers works.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
**Cilium Release:** X.XX

**Authors:** alice <alice@example.com>, bob jones <bob@example.com>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having some form of "State" field (like "provisional", "implementable", "implemented") is useful because it allows us to merge an early design and update it later if we want. (We can just go straight to implemented though).

This one's non-blocking though, it's just been nice in other places.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've created #4 to track this and have the conversation there

@xmulligan xmulligan linked an issue Feb 17, 2023 that may be closed by this pull request
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
cfps/CFP-002-template.md Outdated Show resolved Hide resolved
cfps/CFP-002-template.md Outdated Show resolved Hide resolved
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

README.md Outdated
file as an outline. The structure of this template is meant to provide a starting
point for people. Feel free to edit and modify your outline to best fit your
needs when creating a proposal. The title should be `CFP-###-subject.md`
where the number is the CFP issue number.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does a contributor know what the "CFP issue number" is?

Should contributors open a new issue first, or should they open a blank PR and then update it to pick a number? (How does k8s do this? 🤔 )

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

k8s has you open an issue first, and uses that as the basis.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another question from me: What about design proposal for Cilium org repos other than cilium/cilium? I guess the simplest answer here is that the process is something like this:

  1. Create a CFP issue in the repo your design applies to. (ie, cilium/cilium, cilium/tetragon, etc)
  2. Create the file in this repo, with a path of cfps/<repo>/CFP-####-subject.md.
  3. Merging the file into this repo constitutes acceptance of the design (or something to that effect).

This is imposing this requirement on other projects (like Tetragon), but I suspect that's going to end up a win in the longer term.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tried to capture this below. # 3 should be covered in "getting a designed approved" below.

I don't think this is actually imposing a requirement on other projects because they could decided to do something else and we would end up with just a cilium folder

cfps/CFP-002-template.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@youngnick
Copy link
Contributor

That's everything I can think of, this LGTM. Looking forward to bringing the mTLS CFP in here. 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CFP Template
5 participants