{"id":19002308,"url":"https://github.com/linkerd/rfc","last_synced_at":"2025-04-22T18:04:02.741Z","repository":{"id":43164122,"uuid":"144336746","full_name":"linkerd/rfc","owner":"linkerd","description":"Architectural proposals related to Linkerd.","archived":false,"fork":false,"pushed_at":"2023-04-10T14:43:26.000Z","size":110,"stargazers_count":5,"open_issues_count":5,"forks_count":18,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-17T08:59:39.120Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/linkerd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-08-10T22:14:15.000Z","updated_at":"2024-09-03T20:44:30.000Z","dependencies_parsed_at":"2025-04-16T23:05:43.634Z","dependency_job_id":"0fee608d-af37-4ece-a494-41878bbb5187","html_url":"https://github.com/linkerd/rfc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkerd%2Frfc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkerd%2Frfc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkerd%2Frfc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linkerd%2Frfc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linkerd","download_url":"https://codeload.github.com/linkerd/rfc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250295979,"owners_count":21407036,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T18:14:36.664Z","updated_at":"2025-04-22T18:04:02.696Z","avatar_url":"https://github.com/linkerd.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Linkerd RFCs\n\nMany changes, including bug fixes and documentation improvements can be\nimplemented and reviewed via the normal GitHub pull request workflow. However,\nsome changes are \"substantial\" and we ask that these be put through a bit of a\ndesign process to produce a consensus among the Linkerd community.\n\nThe \"RFC\" (request for comments) process is intended to provide a consistent and\ncontrolled path for contributions to enter the project, so that all stakeholders\ncan be confident about the project direction and maintainability of the\ncodebase.\n\n## When you need to follow this process\n\n[when you need to follow this process]: #when-you-need-to-follow-this-process\n\nYou need to follow this process if you intend to make \"substantial\" changes to\nLinkerd2 (Linkerd2-proxy, Linkerd Control Plane) or the RFC process itself. What\nconstitutes an \"substantial\" is a foundational concern for the Linkerd project.\n\nSimilarly, any technical effort (refactoring, major architectural change) that\nwill impact a large section of the development community should also be\ncommunicated widely. The Linkerd RFC process is suited for this even if it will\nhave zero impact on the typical user or operator.\n\n## Before creating an RFC\n\n[before creating an rfc]: #before-creating-an-rfc\n\nA hastily-proposed RFC can hurt its chances of acceptance. Low quality\nproposals, proposals for previously-rejected features, or those that don't fit\ninto the near-term roadmap, may be quickly rejected, which can be demotivating\nfor the unprepared contributor. Laying some groundwork ahead of the RFC can make\nthe process smoother.\n\nAlthough there is no single way to prepare for submitting an RFC, it is\ngenerally a good idea to pursue feedback from other project developers\nbeforehand, to ascertain that the RFC may be desirable; having a consistent\nimpact on the project requires concerted effort toward consensus-building.\n\nThe most common preparations for writing and submitting an RFC include talking\nthe idea over on our [Linkerd Slack, #contributors](https://slack.linkerd.io),\nor discussing the topic on our [CNCF developer mailing\nlist](https://lists.cncf.io/g/cncf-linkerd-dev). You may file issues on this\nrepo for discussion, but these are not actively looked at by the teams.\n\nAs a rule of thumb, receiving encouraging feedback from long-standing project\ndevelopers is a good indication that the RFC is worth pursuing.\n\n## What the process is\n\n[what the process is]: #what-the-process-is\n\nTo get a major feature added to Linkerd, one must get the RFC merged into the\nRFC repository in either one or two steps.\n\nFirst, the problem statement should be completed. If one does not intend to\ndesign or implement the RFC, then the proposal can be merged as is after going\nthrough reviews.\n\nSecond, the design proposal is completed. Once the design is accepted, the RFC\nis considered active and may be implemented with the goal of eventual inclusion\ninto Linkerd.\n\nIf one intends to state the problem and propose a design, then both sections can\nbe completed in a single review.\n\n### Step 1\n\n1. Fork the [RFC repository](https://github.com/linkerd/rfc)\n2. Copy `0000-rfc-template.md` to `problem/0000-my-contribution.md` (where\n   \"my-contribution\" is descriptive.).\n3. Fill in the RFC. Leave `Design Proposal` section for `Step 2` if you do not\n   intend to propose a design, or would like to first gather feedback on the\n   problem.\n4. If completing RFC in separate steps, submit a pull request. As a pull request\n   `Problem statement` will receive feedback from the larger community, and the\n   author should be prepared to revise it in response.\n\n### Step 2\n\n1. Move `problem/0000-my-contribution.md` to `design/0000-my-contribution.md`.\n2. Fill in the `Design proposal` section. Put care into the details: RFCs that\n   do not present convincing motivation, demonstrate lack of understanding of\n   the design's impact, or are disingenuous about the drawbacks or alternatives\n   tend to be poorly-received\n3. Submit a pull request. As a pull request `Design proposal` will receive\n   feedback from the larger community, and the author should be prepared to\n   revise it in response.\n\n### Note\n\n- If you have not already gathered feedback on the problem, it is advised to\n  complete the process in two steps; it is better to ensure the problem needs to\n  be solved before spending time on the design.\n- Each pull request will be labeled with the most relevant reviewer, who will\n  lead its triage.\n- Build consensus and integrate feedback. RFCs that have broad support are much\n  more likely to make progress than those that don't receive any comments. Feel\n  free to reach out to the RFC assignee in particular to get help identifying\n  stakeholders and obstacles.\n- The team will discuss the RFC pull request, as much as possible in the comment\n  thread of the pull request itself. Offline discussion will be summarized on\n  the pull request comment thread.\n\nRFCs rarely go through this process unchanged, especially as alternatives and\ndrawbacks are shown. You can make edits, big and small, to the RFC to clarify or\nchange the design, but make changes as new commits to the pull request, and\nleave a comment on the pull request explaining your changes. Specifically, do\nnot squash or rebase commits after they are visible on the pull request.\n\n## The RFC life-cycle\n\n[the rfc life-cycle]: #the-rfc-life-cycle\n\nOnce an RFC becomes \"active\" then authors may implement it and submit the\nfeature as a series of pull requests to the Linkerd2 repo. Being \"active\" is not\na rubber stamp, and in particular still does not mean the feature will\nultimately be merged; it does mean that in principle all the major stakeholders\nhave agreed to the feature and are amenable to merging it.\n\nFurthermore, the fact that a given RFC has been accepted and is \"active\" implies\nnothing about what priority is assigned to its implementation, nor does it imply\nanything about whether a maintainer has been assigned the task of implementing\nthe feature. While it is not _necessary_ that the author of the RFC also write\nthe implementation, it is by far the most effective way to see an RFC through to\ncompletion: authors should not expect that other project developers will take on\nresponsibility for implementing their accepted feature.\n\nModifications to \"active\" RFCs can be done in follow-up pull requests. We strive\nto write each RFC in a manner that it will reflect the final design of the\nfeature; but the nature of the process means that we cannot expect every merged\nRFC to actually reflect what the end result will be at the time of the next\nmajor release.\n\nIn general, once accepted, RFCs should not be substantially changed. Only very\nminor changes should be submitted as amendments. More substantial changes should\nbe new RFCs, with a note added to the original RFC. Exactly what counts as a\n\"very minor change\" is up to the team to decide.\n\n## Implementing an RFC\n\n[implementing an rfc]: #implementing-an-rfc\n\nSome accepted RFCs represent vital features that need to be implemented right\naway. Other accepted RFCs can represent features that can wait until some\narbitrary developer feels like doing the work. Every accepted RFC has an\nassociated issue tracking its implementation in the Linkerd2 repository; thus\nthat associated issue can be assigned a priority via the triage process that the\nteam uses for all issues in the Linkerd2 repository.\n\nThe author of an RFC is not obligated to implement it. Of course, the RFC author\n(like any other developer) is welcome to post an implementation for review after\nthe RFC has been accepted.\n\nIf you are interested in working on the implementation for an \"active\" RFC, but\ncannot determine if someone else is already working on it, feel free to ask\n(e.g.by leaving a comment on the associated issue).\n\n### Help this is all too informal\n\n[help this is all too informal!]: #help-this-is-all-too-informal\n\nThe process is intended to be as lightweight as reasonable for the present\ncircumstances. As usual, we are trying to let the process be driven by consensus\nand community norms, not impose more structure than necessary.\n\n## License\n\n[license]: #license\n\nThis repository is currently licensed under:\n\n- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or\n  \u003chttp://www.apache.org/licenses/LICENSE-2.0)\u003e\n- \u003chttps://github.com/linkerd/linkerd2/blob/master/LICENSE\u003e\n\n### Contributions\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\nlicensed as above, without any additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinkerd%2Frfc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinkerd%2Frfc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinkerd%2Frfc/lists"}