{"id":19901930,"url":"https://github.com/hyperledger/firefly-fir","last_synced_at":"2026-03-05T06:32:21.421Z","repository":{"id":37556196,"uuid":"426340200","full_name":"hyperledger/firefly-fir","owner":"hyperledger","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-08T19:29:31.000Z","size":780,"stargazers_count":5,"open_issues_count":4,"forks_count":3,"subscribers_count":13,"default_branch":"main","last_synced_at":"2026-01-30T17:46:09.613Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperledger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-11-09T18:23:40.000Z","updated_at":"2024-04-26T17:23:10.000Z","dependencies_parsed_at":"2024-04-26T18:44:15.343Z","dependency_job_id":null,"html_url":"https://github.com/hyperledger/firefly-fir","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hyperledger/firefly-fir","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-fir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-fir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-fir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-fir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperledger","download_url":"https://codeload.github.com/hyperledger/firefly-fir/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-fir/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30112244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T03:40:26.266Z","status":"ssl_error","status_checked_at":"2026-03-05T03:39:15.902Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-11-12T20:16:39.320Z","updated_at":"2026-03-05T06:32:21.396Z","avatar_url":"https://github.com/hyperledger.png","language":null,"readme":"---\nlayout: default\ntitle: FIR Process\nnav_order: 2\n---\n# Hyperledger FireFly FIR Process\n\nMany changes, including bug fixes and documentation improvements can be\nimplemented and reviewed via the normal [GitHub pull request workflow](https://guides.github.com/introduction/flow/).\n\nSome changes though are substantial, and we ask that these be put through a bit\nof a design process and produce a consensus among the FireFly maintainers and\nbroader community.\n\nThe FIR (FireFly Improvement Request) _(pronounced \"fire\")_ process is intended to provide a consistent and\ncontrolled path for major changes to FireFly and other official project\ncomponents, so that all stakeholders can be confident about the direction in\nwhich FireFly is evolving.\n\nThis process is intended to be substantially similar to the RFCs process other\nHyperledger teams have adopted, customized as necessary for use with FireFly.\nThe `README.md` and `0000-template.md` files were forked from the\n[Fabric RFCs repo](https://github.com/hyperledger/fabric-firs) which was in turn forked from the [Sawtooth RFCss repo](https://github.com/hyperledger/sawtooth-firs), which was itself\nderived from the Rust project.\n\n## Table of Contents\n\n- [When you need to follow this process]\n- [Before creating a FIR]\n- [What the process is]\n- [The FIR life-cycle]\n- [Reviewing FIRs]\n- [Implementing a FIR]\n- [License]\n- [Contributions]\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 the\nFireFly Core, any of its sub-components including but not limited to, firefly-ethconnect, firefly-fabconnect or the FIR process\nitself. What constitutes a substantial change is evolving based on community\nnorms and varies depending on what part of the ecosystem you are proposing to\nchange, but may include the following:\n\n- Architectural changes\n- Substantial changes to component interfaces\n- New core features\n- Backward incompatible changes\n- Changes that affect the security of communications or administration\n\nSome changes do not require a FIR:\n\n- Rephrasing, reorganizing, refactoring, or otherwise \"changing shape does not\nchange meaning\".\n- Additions that strictly improve objective, numerical quality criteria\n(warning removal, speedup, better platform coverage, more parallelism, trap\nmore errors, etc.).\n\nIf you submit a pull request to implement a new feature without going through\nthe FIR process, it may be closed with a polite request to submit a FIR first.\n\n## Before creating a FIR\n\n[Before creating a FIR]: #before-creating-a-fir\n\nA hastily-proposed FIR can hurt its chances of acceptance. Low quality\nproposals, proposals for previously-rejected changes, 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 FIR can\nmake the process smoother.\n\nAlthough there is no single way to prepare for submitting a FIR, it is\ngenerally a good idea to pursue feedback from other project developers\nbeforehand, to ascertain that the FIR 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 a FIR include\ntalking the idea over to the [FireFly mailing list](https://lists.hyperledger.org/g/FireFly/topics).\n\nAs a rule of thumb, receiving encouraging feedback from long-standing\nproject developers, and particularly the project's maintainers is a good\nindication that the FIR is worth pursuing.\n\n## What the process is\n\n[What the process is]: #what-the-process-is\n\nIn short, to get a major feature added to FireFly, one must first get the FIR\nmerged into the FIR repository as a markdown file. At that point the FIR is\n\"active\" and may be implemented with the goal of eventual inclusion into\nFireFly.\n\n- Fork [the FIR repository](https://github.com/hyperledger/FireFly-fir).\n- Copy `0000-template.md` to `text/0000-my-feature.md`, where \"my-feature\" is\ndescriptive. Don't assign a FIR number yet.\n- Fill in the FIR. Put care into the details — FIRs that do not present\nconvincing motivation, demonstrate understanding of the impact of the design,\nor are disingenuous about the drawbacks or alternatives tend to be\npoorly received.\n- Submit a pull request. The pull request will be assigned to a maintainer, and\nwill receive design feedback from the larger community; the FIR author should\nbe prepared to revise it in response.\n- Build consensus and integrate feedback. FIRs that have broad support are much\nmore likely to make progress than those that don't receive any comments. Feel\nfree to reach out to the pull request assignee in particular to get help\nidentifying stakeholders and obstacles.\n- The maintainers will discuss the FIR pull request, as much as possible in the\ncomment thread of the pull request itself. Offline discussion will be\nsummarized on the pull request comment thread.\n- A good way to build consensus on a FIR pull request is to summarize the FIR on a\ncommunity contributor meeting. Coordinate with a maintainer to get on a contributor\nmeeting agenda. While this is not necessary, it may help to foster sufficient\nconsensus such that the FIR can proceed to final comment period.\n- FIRs rarely go through this process unchanged, especially as alternatives and\ndrawbacks are shown. You can make edits, big and small, to the FIR to clarify\nor change 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- At some point, a FireFly maintainer will propose a \"motion for final comment\nperiod\" (FCP), along with a *disposition* for the FIR (merge, close, or\npostpone).\n  - This step is taken when enough of the tradeoffs have been discussed that\n  the maintainers are in a position to make a decision. That does not require\n  consensus amongst all participants in the FIR thread (which is usually\n  impossible). However, the argument supporting the disposition on the FIR\n  needs to have already been clearly articulated, and there should not be a\n  strong consensus *against* that position. FireFly maintainers will use their\n  best judgment in taking this step, and the FCP itself ensures there is ample\n  time and notification for stakeholders to push back if it is made\n  prematurely.\n  - For FIRs with lengthy discussion, the motion to FCP is usually preceded by\n  a *summary comment* trying to lay out the current state of the discussion and\n  major trade-offs/points of disagreement.\n  - Before actually entering FCP, the FireFly maintainer who proposes that the\n  FIR enter FCP ensures that other interested maintainers have reviewed the FIR\n  and at least two other maintainers (three total) have indicated agreement;\n  this is often the point at which many maintainers first review the FIR in\n  full depth. Note that maintainers from any FireFly repository may review and\n  indicate agreement, especially for FIRs that impact multiple repositories.\n- The FCP lasts one week, or seven calendar days. It is also advertised widely,\ne.g. in the [FireFly Mailing List](https://lists.hyperledger.org/g/FireFly/topics).\nThis way all stakeholders have a chance to lodge any final objections before a\ndecision is reached.\n- In most cases, the FCP period is quiet since the most interested maintainers\nhave already indicated agreement, and the FIR is either merged or\nclosed. However, sometimes substantial new arguments or ideas are raised, the\nFCP is canceled, and the FIR goes back into development mode.\n\n## The FIR life-cycle\n\n[The FIR life-cycle]: #the-fir-life-cycle\n\nOnce a FIR is merged, it becomes \"active\" and developers may implement it and submit the code\nchange as a pull request to the corresponding FireFly repo. Being \"active\" is\nnot a rubber stamp, and it does not mean the change will ultimately be merged;\nit does mean that in principle all the major stakeholders have agreed to the\nchange, and are amenable to merging it.\n\nFurthermore, the fact that a given FIR has been accepted and is \"active\"\nimplies nothing about what priority is assigned to its implementation, nor does\nit imply anything about whether a FireFly developer has been assigned the task\nof implementing the feature. While it is not *necessary* that the author of the\nFIR also write the implementation, it is by far the most effective way to see\na FIR through to completion: authors should not expect that other project\ndevelopers will take on responsibility for implementing their accepted feature.\n\nModifications to active FIRs can be done in follow-up pull requests. We strive\nto write each FIR 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\nFIR to actually reflect what the end result will be at the time of the next\nmajor release.\n\nIn general, once accepted, FIRs should not be substantially changed. Only very\nminor changes should be submitted as amendments. More substantial changes\nshould be new FIRs, with a note added to the original FIR. Exactly what counts\nas a \"very minor change\" is up to the maintainers to decide.\n\n## Reviewing FIRs\n\n[Reviewing FIRs]: #reviewing-firs\n\nWhile the FIR pull request is up, the maintainers may schedule meetings with\nthe author and/or relevant stakeholders to discuss the issues in greater\ndetail, and in some cases the topic may be discussed at a contributors meeting.\nIn either case a summary from the meeting will be posted back to the FIR pull\nrequest.\n\nThe FireFly maintainers make the final decisions about FIRs after the benefits\nand drawbacks are well understood. These decisions can be made at any time, but\nthe maintainers will regularly issue decisions. When a decision is made, the\nFIR pull request will either be merged or closed. In either case, if the\nreasoning is not clear from the discussion in thread, the maintainers will add\na comment describing the rationale for the decision.\n\n## Implementing a FIR\n\n[Implementing a FIR]: #implementing-a-fir\n\nSome accepted FIRs represent vital changes that need to be implemented right\naway. Other accepted FIRs can represent changes that can wait until a\ndeveloper feels like doing the work. Every accepted FIR has an associated\nissue tracking its implementation in the [FireFly JIRA issue tracker](https://jira.hyperledger.org/projects/FAB/issues).\n\nThe author of a FIR is not obligated to implement it. Of course, the FIR\nauthor, as any other developer, is welcome to post an implementation for review\nafter the FIR has been accepted. Use JIRA for this.\n\n## License\n\n[License]: #license\n\nThis repository is licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)\n([LICENSE](LICENSE)).\n\n## Contributions\n\n[Contributions]: #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\nbe licensed as above, without any additional terms or conditions.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger%2Ffirefly-fir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperledger%2Ffirefly-fir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger%2Ffirefly-fir/lists"}