From 3a587e3557e85844e33d841e5638a72484f142b8 Mon Sep 17 00:00:00 2001 From: Alex North <445306+anorth@users.noreply.github.com> Date: Thu, 26 Oct 2023 08:45:53 +1300 Subject: [PATCH] Remove wording around sequencing of discussion vs drafting --- .github/pull_request_template.md | 15 ++++++--------- .idea/.gitignore | 5 +++++ .idea/FIPs.iml | 12 ++++++++++++ .idea/modules.xml | 8 ++++++++ .idea/vcs.xml | 6 ++++++ templates/{template_FTP.md => template.md} | 2 +- 6 files changed, 38 insertions(+), 10 deletions(-) create mode 100644 .idea/.gitignore create mode 100644 .idea/FIPs.iml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml rename templates/{template_FTP.md => template.md} (97%) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d15c7ddb..6614a07f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,15 +1,12 @@ ## Are you drafting a new FIP? -Please follow these guidelines to help ensure that your proposal is set up for success in the governance process, -and ease the burden on the FIP editors. +Please follow these guidelines to help ensure that your proposal is set up for success in the governance process. -### Start a discussion first -Changes to the Filecoin core protocol start with open discussion. -Please open a new discussion topic in the FIPs repository discussion board and outline you motivation and proposal, -then come back in a few days or weeks to submit your draft FIP. +### Open a discussion topic +Changes to the Filecoin core protocol proceed through open discussion. +Please open a new discussion topic in the FIPs repository discussion board and outline you motivation and proposal. -Don't just paste your FIP draft into a discussion topic. The FIP format is suitable for specifying a concrete protocol change for implementation, -but your discussion post should describe the background and problem to be solved, +but your discussion post should describe more of the background and problem to be solved, outline a range of approaches and their tradeoffs, and invite participants to explore other solutions. Historically, failing to gain some community buy-in before submitting a FIP has often resulted in @@ -34,6 +31,6 @@ Please add yours there in the same PR that adds the FIP draft itself. Use XXXX for the FIP number until it is assigned by an editor. ### Delete this guidance and describe your FIP -If you've followed the guidance above and are ready to submit your FIP draft, +Once you've followed the guidance above and are ready to submit your FIP draft, please delete this text and replace it with a copy of the _Abstract_ from your draft, and a link to the relevant discussion forum topic. \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 00000000..b58b603f --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,5 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/.idea/FIPs.iml b/.idea/FIPs.iml new file mode 100644 index 00000000..24643cc3 --- /dev/null +++ b/.idea/FIPs.iml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<module type="WEB_MODULE" version="4"> + <component name="NewModuleRootManager"> + <content url="file://$MODULE_DIR$"> + <excludeFolder url="file://$MODULE_DIR$/.tmp" /> + <excludeFolder url="file://$MODULE_DIR$/temp" /> + <excludeFolder url="file://$MODULE_DIR$/tmp" /> + </content> + <orderEntry type="inheritedJdk" /> + <orderEntry type="sourceFolder" forTests="false" /> + </component> +</module> \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 00000000..4921d9c9 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project version="4"> + <component name="ProjectModuleManager"> + <modules> + <module fileurl="file://$PROJECT_DIR$/.idea/FIPs.iml" filepath="$PROJECT_DIR$/.idea/FIPs.iml" /> + </modules> + </component> +</project> \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 00000000..35eb1ddf --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project version="4"> + <component name="VcsDirectoryMappings"> + <mapping directory="" vcs="Git" /> + </component> +</project> \ No newline at end of file diff --git a/templates/template_FTP.md b/templates/template.md similarity index 97% rename from templates/template_FTP.md rename to templates/template.md index 2842b5e5..227dcb2a 100644 --- a/templates/template_FTP.md +++ b/templates/template.md @@ -1,7 +1,7 @@ --- fip: "<to be assigned>" <!--keep the qoutes around the fip number, i.e: `fip: "0001"`--> title: <FIP title> -author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)> +author: "<a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>" discussions-to: <URL> status: Draft type: <Technical (Core, Networking, Interface, Informational) | Organizational | Recovery | FRC>