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

Added a template for an issue created for a FLIP #127

Merged
merged 22 commits into from
Aug 21, 2023
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
9c7765a
Added a template for an issue created for a FLIP
vishalchangrani Aug 1, 2023
ce9e5cd
Update .github/ISSUE_TEMPLATE/flip-template.md
vishalchangrani Aug 1, 2023
0fce337
Updating README.md with the new FLIP process
vishalchangrani Aug 1, 2023
af4256e
Update FLIP template to use issue number instead of PR number
vishalchangrani Aug 1, 2023
fb8d2e8
Simplifying the FLIP process by removing additional PR steps
vishalchangrani Aug 1, 2023
5499997
Update flip-template.md
vishalchangrani Aug 2, 2023
ce77c37
Update flip-template.md
vishalchangrani Aug 2, 2023
491c36a
minor updates
vishalchangrani Aug 2, 2023
ab7b863
fixing numbering of bullets
vishalchangrani Aug 2, 2023
1306e9a
Update README.md
vishalchangrani Aug 2, 2023
5d6d4e3
adding additional steps to manage FLIP issue status
vishalchangrani Aug 2, 2023
b706100
Update .github/ISSUE_TEMPLATE/flip-template.md
vishalchangrani Aug 9, 2023
7964896
Update README.md
vishalchangrani Aug 9, 2023
43e2ae6
Update README.md
vishalchangrani Aug 9, 2023
1aed0ce
Update README.md
vishalchangrani Aug 9, 2023
9a1bb87
Update README.md
vishalchangrani Aug 9, 2023
cb8eec1
Update README.md
vishalchangrani Aug 9, 2023
b5059ec
Update README.md
vishalchangrani Aug 9, 2023
a2a913a
making sponsor as mandatory
vishalchangrani Aug 10, 2023
44f1f6b
fixing code of conduct file
vishalchangrani Aug 10, 2023
f75c0d8
adding separate issue template for FLIP type to auto-assign labels
vishalchangrani Aug 21, 2023
bcd5c0c
updating readme to include choice of issue template
vishalchangrani Aug 21, 2023
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
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/flip-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: FLIP issue template
projects: "github/37"
about: Template to create a FLIP
title: Flip Description e.g.Dynamic Inclusion fees
vishalchangrani marked this conversation as resolved.
Show resolved Hide resolved
labels: Proposed
assignees: ''

---

Please ensure you have assigned an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`)
51 changes: 33 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,17 @@ Once the FLIP is ready for review:

1. _(Optional)_ Recruit a sponsor from the maintainers of the project for which your FLIP concerns. A sponsor may help streamline the review process and moderate the discussion with the community.

Please note that you are not required to recruit a sponsor; this step is entirely optional. If howevever, you do recruit a sponsor, identify them in the FLIP before posting the PR in step 2.
Please note that you are not required to recruit a sponsor; this step is entirely optional. If you recruit a sponsor, identify them in the FLIP before posting the PR in step 2.

2. Submit your FLIP as a pull request to this repository ([`onflow/flips`](https://github.com/onflow/flips)).
2. Create an [issue](https://github.com/onflow/flips/issues/new/choose) using the FLIP issue template. The title of the issue should be the title of your FLIP e.g. "Dynamic Inclusion fees".
vishalchangrani marked this conversation as resolved.
Show resolved Hide resolved

Assign an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`)

Submit the issue.

Note the issue number that gets assigned e.g. for issue https://github.com/onflow/flips/issues/76, the issue number is `76`.
vishalchangrani marked this conversation as resolved.
Show resolved Hide resolved

3. Create your FLIP as a pull request to this repository ([`onflow/flips`](https://github.com/onflow/flips)).

Name your FLIP file using the [template](./yyyymmdd-flip-template.md) `YYYYMMDD-descriptive-name.md`,
where YYYYMMDD is the date of submission, and ‘descriptive-name’ relates to the title of your FLIP.
Expand All @@ -115,48 +123,55 @@ Once the FLIP is ready for review:
If you have images or other auxiliary files,
create a directory of the form `YYYYMMDD-descriptive-name` in which to store those files.

Include the header table and the contents of the **Objective** section in the comment of your pull request, using Markdown.
Include a mention of any of the GitHub handles of co-authors, reviewers and, if applicable, sponsors.
Use the issue number generated in step 2 as the FLIP number.

Mention the FLIP issue by copying the github url or the issue in the comment section.
vishalchangrani marked this conversation as resolved.
Show resolved Hide resolved

At the top of the PR identify how long the comment period will be.
This should be a minimum of two weeks from posting the PR.

3. Send a message to the #developers channel on [Discord](https://discord.gg/flow)
with a brief description, and a link to the PR and a request for review.

4. Send a message to the #developers channel on [Discord](https://discord.gg/flow)
with a brief description, a link to the PR and a request for review.

4. The author may request a review committee meeting after sufficient discussion has taken place.
5. On the FLIP issue that was created earlier in Step 2, set the status under the "FLIPs Tracker" project to `Proposed`.
vishalchangrani marked this conversation as resolved.
Show resolved Hide resolved

6. The author may request a review committee meeting after sufficient discussion has taken place.
This meeting will include the FLIP author, core contributors and interested community members.
If discussion is lively, wait until it has settled before going to review.
If the discussion is lively, wait until it has settled before going to review.
The goal of the review meeting is to resolve minor issues;
consensus should be reached on major issues beforehand.

5. The meeting may approve the FLIP, reject it, or require changes before it can be considered again.
7. The meeting may approve the FLIP, reject it, or require changes before it can be considered again.
FLIPs will be merged into this repository ([`onflow/flips`](https://github.com/onflow/flips))
with the outcome of the review process (approval, rejection).

6. Implementations of a successful FLIP should reference it in their documentation. While implementation code is not necessary to start the FLIP process, its existence in full or part may help the design discussion.
8. Update the status of the FLIP issue under the "FLIPs Tracker" project as per the outcome of step 7 (`Accepted` or `Rejected`)
vishalchangrani marked this conversation as resolved.
Show resolved Hide resolved

9. Implementations of a successful FLIP should reference it in their documentation. While implementation code is not necessary to start the FLIP process, its existence in full or part may help the design discussion.


If in any doubt about this process, feel free to ask on [Discord](https://discord.gg/flow),
the [community forum](https://forum.onflow.org/), or file an issue in this repository
([`onflow/flow`](https://github.com/onflow/flow/issues)).

## Proposal states

* **Drafted:** The FLIP has been drafted but is not yet ready for review.
* **Proposed:** The FLIP has been proposed and is awaiting review.
* **Rejected:** The FLIP has been reviewed and been rejected.
* **Rejected:** The FLIP has been reviewed and rejected.
* **Accepted:** The FLIP has been accepted and is either awaiting implementation or is actively being implemented.
* **Implemented (in VERSION):** The FLIP has been implemented.

## Community members

As the purpose of FLIPs is to ensure the community is well represented and served by new changes to Flow,
it is the responsibility of community members to participate in reviewing FLIPs where they have an interest in the outcome.
it is the responsibility of community members to participate in reviewing FLIPs where they are interested in the outcome.

Community members should:

* provide feedback as soon as possible to allow adequate time for consideration
* read FLIPs thoroughly before providing feedback
* be civil and constructive (see [Code of Conduct](CODE_OF_CONDUCT.md))
* Provide feedback as soon as possible to allow adequate time for consideration
* Read FLIPs thoroughly before providing feedback
* Be civil and constructive (see [Code of Conduct](CODE_OF_CONDUCT.md))
Copy link
Contributor

Choose a reason for hiding this comment

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

The link to the Code of Conduct doesn't open - should be removed

Copy link
Member

Choose a reason for hiding this comment

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

The link should not be removed, instead, the missing Code of Conduct should be added to the repo: https://github.com/onflow/flow/blob/master/CODE_OF_CONDUCT.md


## Review committees

Expand All @@ -176,7 +191,7 @@ it is the responsibility of the author (and/or sponsor, if applicable) to ensure

A sponsor is a Flow maintainer, selected by the author at will, and is responsible for ensuring the best possible outcome of the FLIP process.

In particular a sponsor may help with the following-
In particular, a sponsor may help with the following-
vishalchangrani marked this conversation as resolved.
Show resolved Hide resolved

* advocating for the proposed design
* guiding the FLIP to adhere to existing design and style conventions
Expand Down Expand Up @@ -206,7 +221,7 @@ Use the template [from GitHub](./yyyymmdd-flip-template.md), being sure to follo
## FLIP Evaluation

FLIPs should be evaluated for their impact on the three pillars of Flow. These are:
* **Community** - consider how the FLIP will impact the ability for others to participate in the ongoing design and operation of the Flow network and the applications which depend on it.
* **Community** - consider how the FLIP will impact the ability of others to participate in the ongoing design and operation of the Flow network and the applications which depend on it.
* **Empowerment** - consider how the FLIP will improve the economic opportunity for creators, contributors and participants in the community. The FLIP should result in a net positive on the marginal benefits and costs to all the impacted individuals (who choose to register their preference/vote on an issue).
* **Reliability** - and finally, think about how the FLIP will impact the consistency, observability, verifiability, and overall performance of the Flow network for its users.

Expand Down
2 changes: 1 addition & 1 deletion yyyymmdd-flip-template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
status: draft
flip: NNN (set to PR number)
flip: NNN (set to the issue number)
authors: My Name ([email protected]), AN Other ([email protected])
sponsor: AN Expert ([email protected])
updated: YYYY-MM-DD
Expand Down