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

Clarifying main readme #297

Merged
merged 2 commits into from
Nov 4, 2024
Merged

Clarifying main readme #297

merged 2 commits into from
Nov 4, 2024

Conversation

AlexHentschel
Copy link
Member

@AlexHentschel AlexHentschel commented Nov 1, 2024

Overview

updated main README.md at repository root:

  • remove the mentioning of "All NEW FLIPs are numbered by the PR number submitted" which is no longer correct I beleive
  • explained the motivation behind creating an issue first

Motivation for this PR

I don't submit Flips that often and tend to forget details of the submission progress 🤦 . So I quickly looked at the repos main readme and saw the following statement:

  1. Create an issue by using one of the FLIP issue templates based on the type of the FLIP - application, governance, cadence or protocol. The title of the issue should be the title of your FLIP, e.g., "Dynamic Inclusion fees".
    Submit the issue.
    Note the issue number that gets assigned. For example, for issue #76, the issue number is 76.

So I looked at the example, i.e. issue #76, where it says (!)

All NEW FLIPs are numbered by the PR number submitted. The task here is to update the readme accordingly and then create a PR request template with a copy of the FLIP acceptance requirements in checklist form.

This was enough to derail me and get the impression that the readme was outdated; especially given that issue #76 is still open.

After more detailed discussions (slack convo - not publicly accessible, sorry), it turns out that issue #76 is incorrect our outdated I believe.

• remove the mentioning of "All NEW FLIPs are numbered by the PR number submitted." which is no longer correct
• explained the motivation behind creating an issue first
@@ -81,6 +81,8 @@ will solve it. Specifically, the FLIP will:
* be formatted according to the FLIP template
* be submitted as a pull request
* be subject to thorough community discussion and review prior to acceptance or rejection
* for ease of tracking open flips that are currently in the process of discussion and refinement or implementation, we have a dedicated issue for each FLIP,
which is closed when the flip reaches either the `Rejected` or `Released` stage (no further updates to the FLIP)
Copy link
Member Author

@AlexHentschel AlexHentschel Nov 1, 2024

Choose a reason for hiding this comment

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

[issue] is closed when the flip reaches either the Rejected or Released stage (no further updates to the FLIP)

is this correct @vishalchangrani @KshitijChaudhary666 ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes that is principally correct, but also relies upon the FLIP owners to close the issues created

@AlexHentschel
Copy link
Member Author

AlexHentschel commented Nov 1, 2024

@vishalchangrani @KshitijChaudhary666 would appreciate your input on this. I got confused and did the wrong thing at first, so trying to help here by making the readme more precise.

For further context, please see slack convo 👉 https://flow-foundation.slack.com/archives/C074F78ECNL/p1730495915062059 [sorry, not publicly accessible]

@AlexHentschel AlexHentschel removed the request for review from turbolent November 1, 2024 22:11
@AlexHentschel
Copy link
Member Author

@vishalchangrani @KshitijChaudhary666 should we close issue #76 ?

@@ -155,7 +159,7 @@ the [community forum](https://forum.onflow.org/), or file an issue in this repos
([`onflow/flow`](https://github.com/onflow/flow/issues)).

## Proposal states
* **Drafted:** The FLIP is in its early stage and is being ideated.
* **Draft:** The FLIP is in its early stage and is being ideated.
Copy link
Member Author

Choose a reason for hiding this comment

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

changed the status definition from "drafted" to "draft" because updates are ongoing and not yet completed. Thereby, the status also matches the FLIP template, which also uses "draft" and not "drafted"

@KshitijChaudhary666
Copy link
Contributor

@vishalchangrani @KshitijChaudhary666 should we close issue #76 ?

Yes - thanks for the reminder. I just closed it since the readme was already updated after that issue was created

@AlexHentschel AlexHentschel merged commit 9405bcb into main Nov 4, 2024
@AlexHentschel AlexHentschel deleted the alex/readme-clarification branch November 4, 2024 18:05
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.

2 participants