From 9c7765acfd4dae5bee64929e519b911b27e18837 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 15:32:15 -0700 Subject: [PATCH 01/22] Added a template for an issue created for a FLIP --- .github/ISSUE_TEMPLATE/flip-template.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/flip-template.md diff --git a/.github/ISSUE_TEMPLATE/flip-template.md b/.github/ISSUE_TEMPLATE/flip-template.md new file mode 100644 index 00000000..207ee3cb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/flip-template.md @@ -0,0 +1,13 @@ +--- +name: FLIP template +about: Template to create a FLIP +title: Flip Description e.g.Dynamic Inclusion fees +labels: Proposed +assignees: '' + +--- + +Please ensure you have done the following: + +1. Assigned an appropriate [proposal state](https://github.com/onflow/flips#proposal-states) label (one of `Proposed` (default), `Accepted`, `Rejected`, `Implemented`. +2. Assigned an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`) From ce9e5cdf84d3c0d9a94fcbbf7012fced8b87e1c1 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 15:37:23 -0700 Subject: [PATCH 02/22] Update .github/ISSUE_TEMPLATE/flip-template.md --- .github/ISSUE_TEMPLATE/flip-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/flip-template.md b/.github/ISSUE_TEMPLATE/flip-template.md index 207ee3cb..bed36c42 100644 --- a/.github/ISSUE_TEMPLATE/flip-template.md +++ b/.github/ISSUE_TEMPLATE/flip-template.md @@ -1,5 +1,5 @@ --- -name: FLIP template +name: FLIP issue template about: Template to create a FLIP title: Flip Description e.g.Dynamic Inclusion fees labels: Proposed From 0fce3371f3939489448166237d5b1c6335b19c81 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 15:49:19 -0700 Subject: [PATCH 03/22] Updating README.md with the new FLIP process The new FLIP process additionally requires an issue to be created --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cb04489c..216c0b69 100644 --- a/README.md +++ b/README.md @@ -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 title of your FLIP e.g. "Dynamic Inclusion fees". + + 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`. + +4. 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. @@ -121,6 +129,8 @@ Once the FLIP is ready for review: 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. @@ -143,20 +153,20 @@ the [community forum](https://forum.onflow.org/), or file an issue in this repos ## Proposal states * **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)) ## Review committees @@ -176,7 +186,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- * advocating for the proposed design * guiding the FLIP to adhere to existing design and style conventions @@ -206,7 +216,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. From af4256ea4321cdb3c7d818c45bf04b4c70ec2119 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 15:52:22 -0700 Subject: [PATCH 04/22] Update FLIP template to use issue number instead of PR number --- yyyymmdd-flip-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yyyymmdd-flip-template.md b/yyyymmdd-flip-template.md index 68d9620e..e555450b 100644 --- a/yyyymmdd-flip-template.md +++ b/yyyymmdd-flip-template.md @@ -1,6 +1,6 @@ --- status: draft -flip: NNN (set to PR number) +flip: NNN (set to the issue number) authors: My Name (me@example.org), AN Other (you@example.org) sponsor: AN Expert (core-contributor@example.org) updated: YYYY-MM-DD From fb8d2e8d0e8ca7016b72f0c1d864054044750d0b Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 16:19:04 -0700 Subject: [PATCH 05/22] Simplifying the FLIP process by removing additional PR steps Adding instruction to mention the issue in the PR --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 216c0b69..9ac7e28c 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ Once the FLIP is ready for review: Note the issue number that gets assigned e.g. for issue https://github.com/onflow/flips/issues/76 the issue number is `76`. -4. Create your FLIP as a pull request to this repository ([`onflow/flips`](https://github.com/onflow/flips)). +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. @@ -123,28 +123,28 @@ 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. 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) +5. 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. The author may request a review committee meeting after sufficient discussion has taken place. +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. 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 From 5499997452e23972991080ebc4ad44373d99f4c7 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 17:06:46 -0700 Subject: [PATCH 06/22] Update flip-template.md --- .github/ISSUE_TEMPLATE/flip-template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/flip-template.md b/.github/ISSUE_TEMPLATE/flip-template.md index bed36c42..187bf6b9 100644 --- a/.github/ISSUE_TEMPLATE/flip-template.md +++ b/.github/ISSUE_TEMPLATE/flip-template.md @@ -1,5 +1,6 @@ --- name: FLIP issue template +projects: "onflow/37" about: Template to create a FLIP title: Flip Description e.g.Dynamic Inclusion fees labels: Proposed From ce77c371cb8b1f592bc0b03d48fd7d560cd937db Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 19:06:27 -0700 Subject: [PATCH 07/22] Update flip-template.md removing the use of label on issue to track status. --- .github/ISSUE_TEMPLATE/flip-template.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/flip-template.md b/.github/ISSUE_TEMPLATE/flip-template.md index 187bf6b9..dfe95116 100644 --- a/.github/ISSUE_TEMPLATE/flip-template.md +++ b/.github/ISSUE_TEMPLATE/flip-template.md @@ -1,6 +1,6 @@ --- name: FLIP issue template -projects: "onflow/37" +projects: "github/37" about: Template to create a FLIP title: Flip Description e.g.Dynamic Inclusion fees labels: Proposed @@ -8,7 +8,4 @@ assignees: '' --- -Please ensure you have done the following: - -1. Assigned an appropriate [proposal state](https://github.com/onflow/flips#proposal-states) label (one of `Proposed` (default), `Accepted`, `Rejected`, `Implemented`. -2. Assigned an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`) +Please ensure you have assigned an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`) From 491c36a5fb2ab71a50257e6258fcee84d35cc1bc Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 19:09:39 -0700 Subject: [PATCH 08/22] minor updates --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ac7e28c..9cf61054 100644 --- a/README.md +++ b/README.md @@ -106,13 +106,13 @@ Once the FLIP is ready for review: 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. Create an [issue](https://github.com/onflow/flips/issues/new/choose) using the FLIP issue template. The title of the issue should be title of your FLIP e.g. "Dynamic Inclusion fees". +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". 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`. + Note the issue number that gets assigned e.g. for issue https://github.com/onflow/flips/issues/76, the issue number is `76`. 3. Create your FLIP as a pull request to this repository ([`onflow/flips`](https://github.com/onflow/flips)). @@ -132,7 +132,7 @@ Once the FLIP is ready for review: 5. 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. + with a brief description, a link to the PR and a request for review. 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. From ab7b8632fc2fc4c2b3e3c7f7ff06becd64fc5b91 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 19:19:43 -0700 Subject: [PATCH 09/22] fixing numbering of bullets --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9cf61054..caf78a34 100644 --- a/README.md +++ b/README.md @@ -131,20 +131,20 @@ Once the FLIP is ready for review: This should be a minimum of two weeks from posting the PR. -5. Send a message to the #developers channel on [Discord](https://discord.gg/flow) +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. -6. The author may request a review committee meeting after sufficient discussion has taken place. +5. 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 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. -7. The meeting may approve the FLIP, reject it, or require changes before it can be considered again. +6. 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). -8. 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. +7. 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 From 1306e9a6212e972b7ca30795bf245f367dc6dbdd Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 19:21:59 -0700 Subject: [PATCH 10/22] Update README.md Adding Drafted status --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index caf78a34..4bf1f248 100644 --- a/README.md +++ b/README.md @@ -151,7 +151,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 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 rejected. * **Accepted:** The FLIP has been accepted and is either awaiting implementation or is actively being implemented. From 5d6d4e3c9544abefd01fca458abfc717421c1634 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Tue, 1 Aug 2023 19:32:03 -0700 Subject: [PATCH 11/22] adding additional steps to manage FLIP issue status --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4bf1f248..74d775da 100644 --- a/README.md +++ b/README.md @@ -134,17 +134,22 @@ Once the FLIP is ready 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. -5. 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`. + +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 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. -6. 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). -7. 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`) + +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 From b7061003268b5c572d04ed7aeec91e1ae8534694 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 16:26:16 -0700 Subject: [PATCH 12/22] Update .github/ISSUE_TEMPLATE/flip-template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bastian Müller --- .github/ISSUE_TEMPLATE/flip-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/flip-template.md b/.github/ISSUE_TEMPLATE/flip-template.md index dfe95116..de5d81f6 100644 --- a/.github/ISSUE_TEMPLATE/flip-template.md +++ b/.github/ISSUE_TEMPLATE/flip-template.md @@ -2,7 +2,7 @@ name: FLIP issue template projects: "github/37" about: Template to create a FLIP -title: Flip Description e.g.Dynamic Inclusion fees +title: FLIP title, e.g., "Dynamic Inclusion fees" labels: Proposed assignees: '' From 7964896063b006020a3d2f6b48a5d1d5f3239010 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 16:26:44 -0700 Subject: [PATCH 13/22] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bastian Müller --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74d775da..1a15c3d9 100644 --- a/README.md +++ b/README.md @@ -108,11 +108,12 @@ Once the FLIP is ready for review: 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". - Assign an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`) + Assign an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`). + If you do not have the permission, you may need to ask the sponsor to assist you. 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`. + Note the issue number that gets assigned. For example, for issue https://github.com/onflow/flips/issues/76, the issue number is `76`. 3. Create your FLIP as a pull request to this repository ([`onflow/flips`](https://github.com/onflow/flips)). From 43e2ae6241cd3c93b6feae77acc57d2947a28222 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 16:26:56 -0700 Subject: [PATCH 14/22] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bastian Müller --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a15c3d9..0fa1b515 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,8 @@ Once the FLIP is ready for review: FLIPs will be merged into this repository ([`onflow/flips`](https://github.com/onflow/flips)) with the outcome of the review process (approval, rejection). -8. Update the status of the FLIP issue under the "FLIPs Tracker" project as per the outcome of step 7 (`Accepted` or `Rejected`) +8. Update the status of the FLIP issue under the "FLIPs Tracker" project as per the outcome of step 7 (`Accepted` or `Rejected`). + If you do not have the permission, you may need to ask the sponsor to assist you. 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. From 1aed0ce388206627593137f7a80571656e91ca0c Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 16:27:04 -0700 Subject: [PATCH 15/22] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bastian Müller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fa1b515..dbe29894 100644 --- a/README.md +++ b/README.md @@ -193,7 +193,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: * advocating for the proposed design * guiding the FLIP to adhere to existing design and style conventions From 9a1bb870bf822c0c06baa8cd762052d3c5396b78 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 16:27:14 -0700 Subject: [PATCH 16/22] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bastian Müller --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index dbe29894..eb5415a5 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,7 @@ Once the FLIP is ready for review: with a brief description, a link to the PR and a request for review. 5. On the FLIP issue that was created earlier in Step 2, set the status under the "FLIPs Tracker" project to `Proposed`. + If you do not have the permission, you may need to ask the sponsor to assist you. 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. From cb8eec14d184b0c487c298512e522db9f4fe811f Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 16:27:21 -0700 Subject: [PATCH 17/22] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bastian Müller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eb5415a5..f1a61e76 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ Once the FLIP is ready for review: 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. + Mention the FLIP issue by copying the GitHub URL or the issue in the comment section. 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. From b5059ece4ef133a4fb883e227e34e1b0cda60dc4 Mon Sep 17 00:00:00 2001 From: Vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 16:27:56 -0700 Subject: [PATCH 18/22] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bastian Müller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f1a61e76..723d5c5b 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ Once the FLIP is ready for review: 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. 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". +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". Assign an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`). If you do not have the permission, you may need to ask the sponsor to assist you. From a2a913a11a3bf2cfe58e0c14369f7520d60e115e Mon Sep 17 00:00:00 2001 From: vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 17:11:07 -0700 Subject: [PATCH 19/22] making sponsor as mandatory --- CODE_OF_CONDUCT.md | 1 + README.md | 10 ++++------ 2 files changed, 5 insertions(+), 6 deletions(-) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..989b268c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +{"payload":{"allShortcutsEnabled":false,"fileTree":{"":{"items":[{"name":".github","path":".github","contentType":"directory"},{"name":"docs","path":"docs","contentType":"directory"},{"name":"flips","path":"flips","contentType":"directory"},{"name":"nodeoperators","path":"nodeoperators","contentType":"directory"},{"name":"openapi","path":"openapi","contentType":"directory"},{"name":"protobuf","path":"protobuf","contentType":"directory"},{"name":"specs","path":"specs","contentType":"directory"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":"CODE_OF_CONDUCT.md","path":"CODE_OF_CONDUCT.md","contentType":"file"},{"name":"LICENSE","path":"LICENSE","contentType":"file"},{"name":"NOTICE","path":"NOTICE","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"SECURITY.md","path":"SECURITY.md","contentType":"file"},{"name":"sporks.json","path":"sporks.json","contentType":"file"}],"totalCount":14}},"fileTreeProcessingTime":2.9927289999999998,"foldersToFetch":[],"reducedMotionEnabled":null,"repo":{"id":256037426,"defaultBranch":"master","name":"flow","ownerLogin":"onflow","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2020-04-15T21:09:27.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/62387156?v=4","public":true,"private":false,"isOrgOwned":true},"refInfo":{"name":"master","listCacheKey":"v0:1691185537.0","canEdit":false,"refType":"branch","currentOid":"01ffd3887c4edeb900d19c43f1fb4a865bf756f9"},"path":"CODE_OF_CONDUCT.md","currentUser":null,"blob":{"rawLines":null,"stylingDirectives":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/onflow/flow/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null,"repoAlertsPath":"/onflow/flow/security/dependabot","repoSecurityAndAnalysisPath":"/onflow/flow/settings/security_analysis","repoOwnerIsOrg":true,"currentUserCanAdminRepo":false},"displayName":"CODE_OF_CONDUCT.md","displayUrl":"https://github.com/onflow/flow/blob/master/CODE_OF_CONDUCT.md?raw=true","headerInfo":{"blobSize":"5.1 KB","deleteInfo":{"deleteTooltip":"You must be signed in to make or propose changes"},"editInfo":{"editTooltip":"You must be signed in to make or propose changes"},"ghDesktopPath":"https://desktop.github.com","gitLfsPath":null,"onBranch":true,"shortPath":"bf63234","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fonflow%2Fflow%2Fblob%2Fmaster%2FCODE_OF_CONDUCT.md","isCSV":false,"isRichtext":true,"toc":[{"level":1,"text":"Contributor Covenant Code of Conduct","anchor":"contributor-covenant-code-of-conduct","htmlText":"Contributor Covenant Code of Conduct"},{"level":2,"text":"Our Pledge","anchor":"our-pledge","htmlText":"Our Pledge"},{"level":2,"text":"Our Standards","anchor":"our-standards","htmlText":"Our Standards"},{"level":2,"text":"Enforcement Responsibilities","anchor":"enforcement-responsibilities","htmlText":"Enforcement Responsibilities"},{"level":2,"text":"Scope","anchor":"scope","htmlText":"Scope"},{"level":2,"text":"Enforcement","anchor":"enforcement","htmlText":"Enforcement"},{"level":2,"text":"Enforcement Guidelines","anchor":"enforcement-guidelines","htmlText":"Enforcement Guidelines"},{"level":3,"text":"1. Correction","anchor":"1-correction","htmlText":"1. Correction"},{"level":3,"text":"2. Warning","anchor":"2-warning","htmlText":"2. Warning"},{"level":3,"text":"3. Temporary Ban","anchor":"3-temporary-ban","htmlText":"3. Temporary Ban"},{"level":3,"text":"4. Permanent Ban","anchor":"4-permanent-ban","htmlText":"4. Permanent Ban"},{"level":2,"text":"Attribution","anchor":"attribution","htmlText":"Attribution"}],"lineInfo":{"truncatedLoc":"128","truncatedSloc":"92"},"mode":"file"},"image":false,"isCodeownersFile":null,"isValidLegacyIssueTemplate":false,"issueTemplateHelpUrl":"https://docs.github.com/articles/about-issue-and-pull-request-templates","issueTemplate":null,"discussionTemplate":null,"language":"Markdown","languageID":222,"large":false,"loggedIn":false,"newDiscussionPath":"/onflow/flow/discussions/new","newIssuePath":"/onflow/flow/issues/new","planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/onflow/flow/blob/master/CODE_OF_CONDUCT.md","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","dismissStackNoticePath":"/settings/dismiss-notice/publish_stack_from_file","releasePath":"/onflow/flow/releases/new?marketplace=true","showPublishActionBanner":false,"showPublishStackBanner":false},"renderImageOrRaw":false,"richText":"

Contributor Covenant Code of Conduct

\n

Our Pledge

\n

We as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.

\n

We pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.

\n

Our Standards

\n

Examples of behavior that contributes to a positive environment for our\ncommunity include:

\n
    \n
  • Demonstrating empathy and kindness toward other people
    • \n
  • Being respectful of differing opinions, viewpoints, and experiences
    • \n
  • Giving and gracefully accepting constructive feedback
    • \n
  • Accepting responsibility and apologizing to those affected by our mistakes,\nand learning from the experience
    • \n
  • Focusing on what is best not just for us as individuals, but for the\noverall community
    • \n
\n

Examples of unacceptable behavior include:

\n
    \n
  • The use of sexualized language or imagery, and sexual attention or\nadvances of any kind
    • \n
  • Trolling, insulting or derogatory comments, and personal or political attacks
    • \n
  • Public or private harassment
    • \n
  • Publishing others' private information, such as a physical or email\naddress, without their explicit permission
    • \n
  • Other conduct which could reasonably be considered inappropriate in a\nprofessional setting
    • \n
\n

Enforcement Responsibilities

\n

Community leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.

\n

Community leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.

\n

Scope

\n

This Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.

\n

Enforcement

\n

Instances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at community@onflow.org.\nAll complaints will be reviewed and investigated promptly and fairly.

\n

All community leaders are obligated to respect the privacy and security of the\nreporter of any incident.

\n

Enforcement Guidelines

\n

Community leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:

\n

1. Correction

\n

Community Impact: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.

\n

Consequence: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.

\n

2. Warning

\n

Community Impact: A violation through a single incident or series\nof actions.

\n

Consequence: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.

\n

3. Temporary Ban

\n

Community Impact: A serious violation of community standards, including\nsustained inappropriate behavior.

\n

Consequence: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.

\n

4. Permanent Ban

\n

Community Impact: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.

\n

Consequence: A permanent ban from any sort of public interaction within\nthe community.

\n

Attribution

\n

This Code of Conduct is adapted from the Contributor Covenant,\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

\n

Community Impact Guidelines were inspired by Mozilla's code of conduct\nenforcement ladder.

\n

For answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.

\n
","renderedFileInfo":null,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"repoOwner":"onflow","repoName":"flow","showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","showDependabotConfigurationBanner":false,"actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timedOut":false,"notAnalyzed":true,"symbols":[]}},"copilotInfo":null,"csrf_tokens":{"/onflow/flow/branches":{"post":"ZNzV0DEbaO2_wttqjS-IT1uw6gEIK9nwXDHRREVfPyKxh8TkheQ827Z-LMmjYdbEZsxEoJ1ekRY21Ir70FywZw"}}},"title":"flow/CODE_OF_CONDUCT.md at master · onflow/flow"} \ No newline at end of file diff --git a/README.md b/README.md index 723d5c5b..83c977a7 100644 --- a/README.md +++ b/README.md @@ -74,8 +74,7 @@ Everyone is welcome to propose and provide feedback on a FLIP. A **FLIP author** writes a FLIP and is committed to championing it through the process. -If deemend necessary, a FLIP author may have a **FLIP sponsor** who helps shepherd the -FLIP review process. +A FLIP author will find a **FLIP sponsor** who helps shepherd the FLIP review process. A **review committee** is a group of maintainers who are responsible for the strategic direction of components, subcomponents, and public APIs. They have the responsibility to accept or reject the adoption of the FLIP via a community vote. @@ -102,9 +101,7 @@ After writing the FLIP draft, gather feedback from project contributors and main 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 you recruit a sponsor, identify them in the FLIP before posting the PR in step 2. +1. Recruit a [sponsor](#flip-sponsors) from the maintainers or the active contributors of the project for which your FLIP concerns. A sponsor may help streamline the review process and moderate the discussion with the community 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". @@ -190,7 +187,7 @@ Review committees must: If a review committee requires changes before acceptance, it is the responsibility of the author (and/or sponsor, if applicable) to ensure these are made and seek subsequent approval from the committee members. -## FLIP sponsors (optional) +## FLIP sponsors 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. @@ -202,6 +199,7 @@ In particular, a sponsor may help with the following: * if the FLIP is approved and moves to implementation: * ensuring proposed implementation adheres to the design * liaison with appropriate parties to successfully land implementation +* update the status of the issue created for the FLIP ## Keeping the bar high From 44f1f6bdc6fb484eef808d88e696a649abd74fdc Mon Sep 17 00:00:00 2001 From: vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Wed, 9 Aug 2023 17:14:40 -0700 Subject: [PATCH 20/22] fixing code of conduct file --- CODE_OF_CONDUCT.md | 129 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 128 insertions(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 989b268c..bf632346 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1 +1,128 @@ -{"payload":{"allShortcutsEnabled":false,"fileTree":{"":{"items":[{"name":".github","path":".github","contentType":"directory"},{"name":"docs","path":"docs","contentType":"directory"},{"name":"flips","path":"flips","contentType":"directory"},{"name":"nodeoperators","path":"nodeoperators","contentType":"directory"},{"name":"openapi","path":"openapi","contentType":"directory"},{"name":"protobuf","path":"protobuf","contentType":"directory"},{"name":"specs","path":"specs","contentType":"directory"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":"CODE_OF_CONDUCT.md","path":"CODE_OF_CONDUCT.md","contentType":"file"},{"name":"LICENSE","path":"LICENSE","contentType":"file"},{"name":"NOTICE","path":"NOTICE","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"SECURITY.md","path":"SECURITY.md","contentType":"file"},{"name":"sporks.json","path":"sporks.json","contentType":"file"}],"totalCount":14}},"fileTreeProcessingTime":2.9927289999999998,"foldersToFetch":[],"reducedMotionEnabled":null,"repo":{"id":256037426,"defaultBranch":"master","name":"flow","ownerLogin":"onflow","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2020-04-15T21:09:27.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/62387156?v=4","public":true,"private":false,"isOrgOwned":true},"refInfo":{"name":"master","listCacheKey":"v0:1691185537.0","canEdit":false,"refType":"branch","currentOid":"01ffd3887c4edeb900d19c43f1fb4a865bf756f9"},"path":"CODE_OF_CONDUCT.md","currentUser":null,"blob":{"rawLines":null,"stylingDirectives":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/onflow/flow/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null,"repoAlertsPath":"/onflow/flow/security/dependabot","repoSecurityAndAnalysisPath":"/onflow/flow/settings/security_analysis","repoOwnerIsOrg":true,"currentUserCanAdminRepo":false},"displayName":"CODE_OF_CONDUCT.md","displayUrl":"https://github.com/onflow/flow/blob/master/CODE_OF_CONDUCT.md?raw=true","headerInfo":{"blobSize":"5.1 KB","deleteInfo":{"deleteTooltip":"You must be signed in to make or propose changes"},"editInfo":{"editTooltip":"You must be signed in to make or propose changes"},"ghDesktopPath":"https://desktop.github.com","gitLfsPath":null,"onBranch":true,"shortPath":"bf63234","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fonflow%2Fflow%2Fblob%2Fmaster%2FCODE_OF_CONDUCT.md","isCSV":false,"isRichtext":true,"toc":[{"level":1,"text":"Contributor Covenant Code of Conduct","anchor":"contributor-covenant-code-of-conduct","htmlText":"Contributor Covenant Code of Conduct"},{"level":2,"text":"Our Pledge","anchor":"our-pledge","htmlText":"Our Pledge"},{"level":2,"text":"Our Standards","anchor":"our-standards","htmlText":"Our Standards"},{"level":2,"text":"Enforcement Responsibilities","anchor":"enforcement-responsibilities","htmlText":"Enforcement Responsibilities"},{"level":2,"text":"Scope","anchor":"scope","htmlText":"Scope"},{"level":2,"text":"Enforcement","anchor":"enforcement","htmlText":"Enforcement"},{"level":2,"text":"Enforcement Guidelines","anchor":"enforcement-guidelines","htmlText":"Enforcement Guidelines"},{"level":3,"text":"1. Correction","anchor":"1-correction","htmlText":"1. Correction"},{"level":3,"text":"2. Warning","anchor":"2-warning","htmlText":"2. Warning"},{"level":3,"text":"3. Temporary Ban","anchor":"3-temporary-ban","htmlText":"3. Temporary Ban"},{"level":3,"text":"4. Permanent Ban","anchor":"4-permanent-ban","htmlText":"4. Permanent Ban"},{"level":2,"text":"Attribution","anchor":"attribution","htmlText":"Attribution"}],"lineInfo":{"truncatedLoc":"128","truncatedSloc":"92"},"mode":"file"},"image":false,"isCodeownersFile":null,"isValidLegacyIssueTemplate":false,"issueTemplateHelpUrl":"https://docs.github.com/articles/about-issue-and-pull-request-templates","issueTemplate":null,"discussionTemplate":null,"language":"Markdown","languageID":222,"large":false,"loggedIn":false,"newDiscussionPath":"/onflow/flow/discussions/new","newIssuePath":"/onflow/flow/issues/new","planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/onflow/flow/blob/master/CODE_OF_CONDUCT.md","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","dismissStackNoticePath":"/settings/dismiss-notice/publish_stack_from_file","releasePath":"/onflow/flow/releases/new?marketplace=true","showPublishActionBanner":false,"showPublishStackBanner":false},"renderImageOrRaw":false,"richText":"

Contributor Covenant Code of Conduct

\n

Our Pledge

\n

We as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.

\n

We pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.

\n

Our Standards

\n

Examples of behavior that contributes to a positive environment for our\ncommunity include:

\n
    \n
  • Demonstrating empathy and kindness toward other people
    • \n
  • Being respectful of differing opinions, viewpoints, and experiences
    • \n
  • Giving and gracefully accepting constructive feedback
    • \n
  • Accepting responsibility and apologizing to those affected by our mistakes,\nand learning from the experience
    • \n
  • Focusing on what is best not just for us as individuals, but for the\noverall community
    • \n
\n

Examples of unacceptable behavior include:

\n
    \n
  • The use of sexualized language or imagery, and sexual attention or\nadvances of any kind
    • \n
  • Trolling, insulting or derogatory comments, and personal or political attacks
    • \n
  • Public or private harassment
    • \n
  • Publishing others' private information, such as a physical or email\naddress, without their explicit permission
    • \n
  • Other conduct which could reasonably be considered inappropriate in a\nprofessional setting
    • \n
\n

Enforcement Responsibilities

\n

Community leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.

\n

Community leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.

\n

Scope

\n

This Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.

\n

Enforcement

\n

Instances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at community@onflow.org.\nAll complaints will be reviewed and investigated promptly and fairly.

\n

All community leaders are obligated to respect the privacy and security of the\nreporter of any incident.

\n

Enforcement Guidelines

\n

Community leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:

\n

1. Correction

\n

Community Impact: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.

\n

Consequence: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.

\n

2. Warning

\n

Community Impact: A violation through a single incident or series\nof actions.

\n

Consequence: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.

\n

3. Temporary Ban

\n

Community Impact: A serious violation of community standards, including\nsustained inappropriate behavior.

\n

Consequence: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.

\n

4. Permanent Ban

\n

Community Impact: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.

\n

Consequence: A permanent ban from any sort of public interaction within\nthe community.

\n

Attribution

\n

This Code of Conduct is adapted from the Contributor Covenant,\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

\n

Community Impact Guidelines were inspired by Mozilla's code of conduct\nenforcement ladder.

\n

For answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.

\n
","renderedFileInfo":null,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"repoOwner":"onflow","repoName":"flow","showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","showDependabotConfigurationBanner":false,"actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timedOut":false,"notAnalyzed":true,"symbols":[]}},"copilotInfo":null,"csrf_tokens":{"/onflow/flow/branches":{"post":"ZNzV0DEbaO2_wttqjS-IT1uw6gEIK9nwXDHRREVfPyKxh8TkheQ827Z-LMmjYdbEZsxEoJ1ekRY21Ir70FywZw"}}},"title":"flow/CODE_OF_CONDUCT.md at master · onflow/flow"} \ No newline at end of file + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at . +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. From f75c0d8ff8b76bce6897b43040d4f26f6a3a18ed Mon Sep 17 00:00:00 2001 From: vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Mon, 21 Aug 2023 13:10:15 -0700 Subject: [PATCH 21/22] adding separate issue template for FLIP type to auto-assign labels --- .github/ISSUE_TEMPLATE/application-flip-template.md | 10 ++++++++++ .github/ISSUE_TEMPLATE/cadence-flip-template.md | 10 ++++++++++ .github/ISSUE_TEMPLATE/flip-template.md | 11 ----------- .github/ISSUE_TEMPLATE/governance-flip-template.md | 10 ++++++++++ .github/ISSUE_TEMPLATE/protocol-flip-template.md | 10 ++++++++++ 5 files changed, 40 insertions(+), 11 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/application-flip-template.md create mode 100644 .github/ISSUE_TEMPLATE/cadence-flip-template.md delete mode 100644 .github/ISSUE_TEMPLATE/flip-template.md create mode 100644 .github/ISSUE_TEMPLATE/governance-flip-template.md create mode 100644 .github/ISSUE_TEMPLATE/protocol-flip-template.md diff --git a/.github/ISSUE_TEMPLATE/application-flip-template.md b/.github/ISSUE_TEMPLATE/application-flip-template.md new file mode 100644 index 00000000..cb56c529 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/application-flip-template.md @@ -0,0 +1,10 @@ +--- +name: FLIP issue template +projects: "github/37" +about: Template to create a FLIP +title: FLIP title, e.g., "Dynamic Inclusion fees" +labels: 'flip: application, Proposed' +assignees: '' + +--- + diff --git a/.github/ISSUE_TEMPLATE/cadence-flip-template.md b/.github/ISSUE_TEMPLATE/cadence-flip-template.md new file mode 100644 index 00000000..b60fa700 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cadence-flip-template.md @@ -0,0 +1,10 @@ +--- +name: FLIP issue template +projects: "github/37" +about: Template to create a FLIP +title: FLIP title, e.g., "Dynamic Inclusion fees" +labels: 'flip: cadence, Proposed' +assignees: '' + +--- + diff --git a/.github/ISSUE_TEMPLATE/flip-template.md b/.github/ISSUE_TEMPLATE/flip-template.md deleted file mode 100644 index de5d81f6..00000000 --- a/.github/ISSUE_TEMPLATE/flip-template.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: FLIP issue template -projects: "github/37" -about: Template to create a FLIP -title: FLIP title, e.g., "Dynamic Inclusion fees" -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`) diff --git a/.github/ISSUE_TEMPLATE/governance-flip-template.md b/.github/ISSUE_TEMPLATE/governance-flip-template.md new file mode 100644 index 00000000..2fe45fc4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/governance-flip-template.md @@ -0,0 +1,10 @@ +--- +name: FLIP issue template +projects: "github/37" +about: Template to create a FLIP +title: FLIP title, e.g., "Dynamic Inclusion fees" +labels: 'flip: governance, Proposed' +assignees: '' + +--- + diff --git a/.github/ISSUE_TEMPLATE/protocol-flip-template.md b/.github/ISSUE_TEMPLATE/protocol-flip-template.md new file mode 100644 index 00000000..4ac3f9f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/protocol-flip-template.md @@ -0,0 +1,10 @@ +--- +name: FLIP issue template +projects: "github/37" +about: Template to create a FLIP +title: FLIP title, e.g., "Dynamic Inclusion fees" +labels: 'flip: protocol, Proposed' +assignees: '' + +--- + From bcd5c0c559eb009641caa0d11e76aa50cfd1acb0 Mon Sep 17 00:00:00 2001 From: vishal <1117327+vishalchangrani@users.noreply.github.com> Date: Mon, 21 Aug 2023 13:19:10 -0700 Subject: [PATCH 22/22] updating readme to include choice of issue template --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 83c977a7..487087f7 100644 --- a/README.md +++ b/README.md @@ -103,15 +103,15 @@ Once the FLIP is ready for review: 1. Recruit a [sponsor](#flip-sponsors) from the maintainers or the active contributors of the project for which your FLIP concerns. A sponsor may help streamline the review process and moderate the discussion with the community -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". - Assign an appropriate label for the type of the FLIP (one of `flip:application`, `flip:governance`, `flip:protocol`, `flip:cadence`). - If you do not have the permission, you may need to ask the sponsor to assist you. +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. + Submit the issue. - Note the issue number that gets assigned. For example, for issue https://github.com/onflow/flips/issues/76, the issue number is `76`. - + Note the issue number that gets assigned. For example, for issue https://github.com/onflow/flips/issues/76, the issue number is `76`. + + 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`, @@ -132,22 +132,27 @@ Once the FLIP is ready 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. + 5. On the FLIP issue that was created earlier in Step 2, set the status under the "FLIPs Tracker" project to `Proposed`. If you do not have the permission, you may need to ask the sponsor to assist you. + 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 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. + 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). + 8. Update the status of the FLIP issue under the "FLIPs Tracker" project as per the outcome of step 7 (`Accepted` or `Rejected`). If you do not have the permission, you may need to ask the sponsor to assist you. + 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.