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

* Added a template for an issue created for a FLIP * Update .github/ISSUE_TEMPLATE/flip-template.md * Updating README.md with the new FLIP process The new FLIP process additionally requires an issue to be created * Update FLIP template to use issue number instead of PR number * Simplifying the FLIP process by removing additional PR steps Adding instruction to mention the issue in the PR * Update flip-template.md * Update flip-template.md removing the use of label on issue to track status. * minor updates * fixing numbering of bullets * Update README.md Adding Drafted status * adding additional steps to manage FLIP issue status * Update .github/ISSUE_TEMPLATE/flip-template.md Co-authored-by: Bastian Müller <[email protected]> * Update README.md Co-authored-by: Bastian Müller <[email protected]> * Update README.md Co-authored-by: Bastian Müller <[email protected]> * Update README.md Co-authored-by: Bastian Müller <[email protected]> * Update README.md Co-authored-by: Bastian Müller <[email protected]> * Update README.md Co-authored-by: Bastian Müller <[email protected]> * Update README.md Co-authored-by: Bastian Müller <[email protected]> * making sponsor as mandatory * fixing code of conduct file * adding separate issue template for FLIP type to auto-assign labels * updating readme to include choice of issue template --------- Co-authored-by: Bastian Müller <[email protected]>
onflow · Aug 21, 2023 · 00a9ecf · 00a9ecf
1 parent b78ab9d
commit 00a9ecf
Show file tree

Hide file tree

Showing 7 changed files with 212 additions and 23 deletions.
diff --git a/.github/ISSUE_TEMPLATE/application-flip-template.md 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
@@ -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/governance-flip-template.md 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
@@ -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: ''
+
+---
+
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+
+# 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 <[email protected]>.
+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.
diff --git 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,11 +101,18 @@ 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.
+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
 
-   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.
 
-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) 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 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`,
    where YYYYMMDD is the date of submission, and ‘descriptive-name’ relates to the title of your FLIP.
@@ -115,48 +121,62 @@ 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)
-   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.
+
+
+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.
+
 
-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. 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.
+
 
 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))
 
 ## Review committees
 
@@ -172,18 +192,19 @@ 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.
 
-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
 * guiding the review committee to come to a productive consensus
 * 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
 
@@ -206,7 +227,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.
 

diff --git 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 ([email protected]), AN Other ([email protected]) 
 sponsor: AN Expert ([email protected]) 
 updated: YYYY-MM-DD