{"id":14063199,"url":"https://github.com/foambubble/rfcs","last_synced_at":"2025-07-29T14:32:26.740Z","repository":{"id":103096607,"uuid":"282058284","full_name":"foambubble/rfcs","owner":"foambubble","description":"Foam RFCs (Requests for Comment)","archived":true,"fork":false,"pushed_at":"2020-08-05T11:56:59.000Z","size":29,"stargazers_count":7,"open_issues_count":5,"forks_count":5,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-12-04T00:32:59.533Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foambubble.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-07-23T21:24:29.000Z","updated_at":"2023-01-28T07:57:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"20a402ba-f819-4054-a1be-543cc92fd5c4","html_url":"https://github.com/foambubble/rfcs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/foambubble/rfcs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foambubble%2Frfcs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foambubble%2Frfcs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foambubble%2Frfcs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foambubble%2Frfcs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foambubble","download_url":"https://codeload.github.com/foambubble/rfcs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foambubble%2Frfcs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267703066,"owners_count":24130463,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-08-13T07:03:08.125Z","updated_at":"2025-07-29T14:32:26.297Z","avatar_url":"https://github.com/foambubble.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# Foam RFCs\r\n\r\nMany changes, including bug fixes and documentation improvements can be\r\nimplemented and reviewed via the normal GitHub pull request workflow.\r\n\r\nSome changes though are \"substantial\", and we ask that these be put\r\nthrough a bit of a design process and produce a consensus among the Foam\r\nmaintainers and the sub-teams.\r\n\r\nThe \"RFC\" (request for comments) process is intended to provide a\r\nconsistent and controlled path for new features to enter the project.\r\n\r\n[Active RFC List](https://github.com/foambubble/rfcs/pulls)\r\n\r\nFoam is still **actively developing** this process, and it will still change as\r\nmore features are implemented and the community settles on specific approaches\r\nto feature development.\r\n\r\n## When to follow this process\r\n\r\nYou should consider using this process if you intend to make \"substantial\"\r\nchanges to Foam or its documentation. Some examples that would benefit\r\nfrom an RFC are:\r\n\r\n   - A new feature that creates new API surface area or UI functionality\r\n   - The removal of features that already shipped.\r\n   - The introduction of new idiomatic usage or conventions, even if they\r\n     do not include code changes to Foam itself.\r\n\r\nThe RFC process is a great opportunity to get more eyeballs on your proposal\r\nbefore it becomes a part of a released version of Foam. Quite often, even\r\nproposals that seem \"obvious\" can be significantly improved once a wider\r\ngroup of interested people have a chance to weigh in.\r\n\r\nThe RFC process can also be helpful to encourage discussions about a proposed\r\nfeature as it is being designed, and incorporate important constraints into\r\nthe design while it's easier to change, before the design has been fully\r\nimplemented.\r\n\r\nSome changes do not require an RFC:\r\n\r\n  - Rephrasing, reorganizing or refactoring\r\n  - New documentation sections\r\n  - Bugfixes, minor improvements to existing functionality\r\n  - Additions only likely to be _noticed by_ other maintainers-of-Foam,\r\n  invisible to users-of-Foam.\r\n\r\n## What the process is\r\n\r\nIn short, to get a major feature added to Foam, one usually first gets\r\nthe RFC merged into the RFC repo as a markdown file. At that point the RFC\r\nis 'active' and may be implemented with the goal of eventual inclusion\r\ninto Foam.\r\n\r\n* Fork the RFC repo http://github.com/foambubble/rfcs\r\n* Copy `0000-template.md` to `docs/0000-my-feature.md` (where\r\n'my-feature' is descriptive. Don't assign an RFC number yet).\r\n* Change the title of the file to match the file name (e.g. `# 0000 Template` to `# 0000 My Feature`).\r\n* Add a Foam-style wiki link to `docs/index.md` and ensure link reference definitions are appropriately generated.\r\n* Fill in the RFC. Put care into the details: **RFCs that do not\r\npresent convincing motivation, demonstrate understanding of the\r\nimpact of the design, or are disingenuous about the drawbacks or\r\nalternatives tend to be poorly-received**.\r\n* Submit a pull request. As a pull request the RFC will receive design\r\nfeedback from the larger community, and the author should be prepared\r\nto revise it in response.\r\n* Build consensus and integrate feedback. RFCs that have broad support\r\nare much more likely to make progress than those that don't receive any\r\ncomments.\r\n* Eventually, the team will decide whether the RFC is a candidate\r\nfor inclusion in Foam.\r\n* An RFC can be modified based upon feedback from the team and community.\r\nSignificant modifications may trigger a new final comment period.\r\n* An RFC may be rejected by the team after public discussion has settled\r\nand comments have been made summarizing the rationale for rejection. A member of\r\nthe team should then close the RFCs associated pull request.\r\n* An RFC may be accepted at the close of its final comment period. A team\r\nmember will merge the RFCs associated pull request, at which point the RFC will\r\nbecome 'active'.\r\n\r\n## The RFC life-cycle\r\n\r\nOnce an RFC becomes active, then authors may implement it and submit the\r\nfeature as a pull request to the Foam repo. Becoming 'active' is not a rubber\r\nstamp, and in particular still does not mean the feature will ultimately\r\nbe merged; it does mean that the core team has agreed to it in principle\r\nand are amenable to merging it.\r\n\r\nFurthermore, the fact that a given RFC has been accepted and is\r\n'active' implies nothing about what priority is assigned to its\r\nimplementation, nor whether anybody is currently working on it. The team or \r\nsub-team taking responsibility of the feature will choose how to prioritize it. \r\n\r\nModifications to active RFCs can be done in followup PRs. We strive\r\nto write each RFC in a manner that it will reflect the final design of\r\nthe feature; but the nature of the process means that we cannot expect\r\nevery merged RFC to actually reflect what the end result will be at\r\nthe time of the next major release; therefore we try to keep each RFC\r\ndocument somewhat in sync with the language feature as planned,\r\ntracking such changes via followup pull requests to the document.\r\n\r\n## Implementing an RFC\r\n\r\nThe author of an RFC is not obligated to implement it. Of course, the\r\nRFC author (like any other developer) is welcome to post an\r\nimplementation for review after the RFC has been accepted.\r\n\r\nThe likelihood of a feature getting shipped is significantly improved if you are\r\nable to participate in implementing yourself, or if you are able to rally other\r\ncontributors to your cause and motivate them to work on the feature. \r\nA feature may be worked on by the same person(s) who created the RFC, but\r\nthis is not a requirement. It is perfectly valid to open a RFC without intending\r\n(or being able) to implement it yourself.\r\n\r\nIf you are interested in working on the implementation for an 'active'\r\nRFC, but cannot determine if someone else is already working on it,\r\nfeel free to ask (e.g. by leaving a comment on the associated issue).\r\n\r\n**This RFC process is subject to change. If it's not working for us, we'll improve it, or replace it with a more suitable process.**\r\n\r\n**Foams's RFC process owes its inspiration to the [React RFC process], which in turn takes inspiration from [Yarn RFC process], [Rust RFC process], and [Ember RFC process]**\r\n\r\n[React RFC process]: https://github.com/reactjs/rfcs\r\n[Yarn RFC process]: https://github.com/yarnpkg/rfcs\r\n[Rust RFC process]: https://github.com/rust-lang/rfcs\r\n[Ember RFC process]: https://github.com/emberjs/rfcs\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoambubble%2Frfcs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoambubble%2Frfcs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoambubble%2Frfcs/lists"}