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

FIP process amendment to integrate spec update #11

Merged
merged 9 commits into from
Nov 3, 2020

Conversation

yiannisbot
Copy link
Contributor

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

@yiannisbot
Copy link
Contributor Author

@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.

@hugomrdias
Copy link
Contributor

All sections in the spec now have a label that can be easily copy/pasted into a FIP frontmatter.

@yiannisbot
Copy link
Contributor Author

@hugomrdias can you please give an example? For instance, for Section 2: Systems: https://spec.filecoin.io/#section-systems.systems, is the label #section-systems.systems?

Screenshot 2020-10-19 at 22 24 59

@hugomrdias
Copy link
Contributor

spec label example

Copy link
Contributor

@momack2 momack2 left a 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

Copy link
Contributor

@hugomrdias hugomrdias left a 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.

FIPS/fip-0001.md Outdated Show resolved Hide resolved
FIPS/fip-0001.md Outdated Show resolved Hide resolved
FIPS/fip-0001.md Outdated Show resolved Hide resolved
FIPS/fip-0001.md Outdated Show resolved Hide resolved
templates/template_FTP.md Outdated Show resolved Hide resolved
yiannisbot and others added 5 commits October 30, 2020 14:52
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Copy link
Contributor Author

@yiannisbot yiannisbot left a comment

Choose a reason for hiding this comment

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

Very useful changes!

@momack2 momack2 requested review from hugomrdias and daviddias and removed request for daviddias November 3, 2020 03:23
@momack2 momack2 merged commit 728205e into master Nov 3, 2020
@momack2 momack2 deleted the fip-spec-integration branch November 3, 2020 21:54
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.

4 participants