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.

Sign up for GitHub

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
+7 −3
Merged

Clarifying main readme #297

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9978557
updated main readme:
Nov 1, 2024
1634a5b
status definition should be "draft" not drafted
Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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


## FLIP process

Expand All @@ -102,9 +104,11 @@ Once the FLIP is ready for review:
2. Create an [issue](https://github.com/onflow/flips/issues/new/choose) 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.
Then submit the issue and note the issue number that gets assigned. For example, for issue https://github.com/onflow/flips/issues/166, the issue number is `166`.

Note the issue number that gets assigned. For example, for issue https://github.com/onflow/flips/issues/76, the issue number is `76`.
Comment:
The reason we are creating an issue first is to track the progress of the various flips that are currently under discussion, refinement or being implemented.
Hence, from looking at the open https://github.com/onflow/flips/issues you get a concise overview of all FLIPs that you can contribute to, either to helping to refine proposal or contribute to its implementation.


3. Create your FLIP as a pull request to this repository ([`onflow/flips`](https://github.com/onflow/flips)).
Expand Down Expand Up @@ -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"

* **Proposed:** The FLIP has been proposed and is awaiting review.
* **Rejected:** The FLIP has been reviewed and rejected.
* **Accepted:** The FLIP has been accepted and is either awaiting implementation or is actively being implemented.
Expand Down