-
Notifications
You must be signed in to change notification settings - Fork 169
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
FIP process amendment to integrate spec update #11
Conversation
@hugomrdias the front matter syntax proposal here does not include the section-specific identifier we discussed previously. Please edit this PR once the per-section identifiers are ready. |
All sections in the spec now have a label that can be easily copy/pasted into a FIP frontmatter. |
@hugomrdias can you please give an example? For instance, for Section 2: Systems: https://spec.filecoin.io/#section-systems.systems, is the label |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good! We discussed in today's Core Devs meeting and generally approved this improvement to help keep the spec up to date: https://www.youtube.com/watch?v=58b8TY9LJaM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added some suggested changes so we can better integrate FIPs in the spec.
Co-authored-by: Hugo Dias <[email protected]>
Co-authored-by: Hugo Dias <[email protected]>
Co-authored-by: Hugo Dias <[email protected]>
Co-authored-by: Hugo Dias <[email protected]>
Co-authored-by: Hugo Dias <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very useful changes!
This PR proposes slight changes to the FIP process to include integration with the Filecoin Specification. There has been discussion and agreement on the fact that if the Filecoin protocol is updated without the changes being directly reflected in the protocol's specification, then the spec will be outdated very soon.
The updates include slight procedural modifications, i.e., a PR to the spec repository is submitted before the FIP is marked as "Final", as well as a small syntax change on the front matter of the FIP Template to indicate which section(s) the FIP is touching upon. This change will allow pulling this information from the FIP repo directly into the Spec repo and will enable us to link to the FIP(s) applied to each section of the spec.
cc: @hugomrdias