From 860d227bde48a0f8dc898b2cbde60969cc29d096 Mon Sep 17 00:00:00 2001 From: David Hawig Date: Fri, 21 Feb 2020 11:49:58 +0100 Subject: [PATCH] Noc2 patch 3 (#255) * Create areas_of_interest.md An initial draft of update areas of interest * Update Repo first commit * Update README.md * Create LICENSE * Update README.md * Update areas_of_interest.md * Update README.md * Update README.md * Update README.md * Update areas_of_interest.md * Update areas_of_interest.md * Rename areas_of_interest.md to polkadot_stack.md * Update README.md * Update README.md * Update polkadot_stack.md * Update polkadot_stack.md * Update polkadot_stack.md * Update polkadot_stack.md * Update polkadot_stack.md * Update polkadot_stack.md * Update readme.md A few small changes. Co-authored-by: Edward Thomson <30219315+EdwardAThomson@users.noreply.github.com> --- LICENSE | 201 +++++++++++++++++++++++++++++++++++++++ README.md | 164 ++++++++++++++++++++------------ development.md | 44 --------- grants/grants.md | 164 -------------------------------- grants/polkadot_stack.md | 128 +++++++++++++++++++++++++ meetups.md | 76 --------------- response-examples.md | 38 -------- 7 files changed, 430 insertions(+), 385 deletions(-) create mode 100644 LICENSE delete mode 100644 development.md delete mode 100644 grants/grants.md create mode 100644 grants/polkadot_stack.md delete mode 100644 meetups.md delete mode 100644 response-examples.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 102d980b6..78de569d5 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,117 @@ -# Web3-collaboration +# Web3 Foundation General Grants Program -This is a public repository to help coordinate our collaboration efforts with teams working in the Web 3 ecosystem. In order to build a better web, the Web3 Foundation will help to coordinate the efforts of teams working towards this common goal. The coordination of efforts will include helping to connect teams, cross-promote the products and protocols, as well as provide strategic [grants](https://github.com/w3f/Web3-collaboration/blob/master/grants/grants.md). +As part of our commitment to promoting the Web3 ecosystem, we offer a comprehensive grants program focused on funding software development and research efforts related to **Polkadot** and **Substrate**. -Our view is that the Polkadot platform will play a pivotal role in the Web 3 ecosystem. To get a better idea of how we think about the ecosystem, we invite you to look at our proposed [Web 3 tech stack](https://github.com/w3f/Web3-wiki/wiki/Tech-Stack). +For smaller technology grants up to **$30k**, which are tracked **transparently** on GitHub and disbursed in **bitcoin**, see our new [Open Grants Program](https://github.com/w3f/Open-Grants-Program). --- -- [About us](#about-us) -- [How this repo will be used](#how-this-repo-will-be-used) - - [Polkadot ecosystem issues](#polkadot-ecosystem-issues) - - [Web3 ecosystem issues](#web3-ecosystem-issues) -- [Who we are looking for](#who-we-are-looking-for) -- [Submission process guidelines](#submission-process-guidelines) -- [Polkadot Meetups](#polkadot-meetups) -- [Additional information](#additional-information) -- [Real-time conversation](#real-time-conversation) - - -## About us -For more information about the Web3 Foundation please visit the ["About Us"](https://github.com/w3f/Web3-wiki/wiki/Web3-Mission-and-Background/_edit) page on our wiki. - -## How this repo will be used -In this repository, we will facilitate collaboration via issue tracking and [grants](https://github.com/w3f/Web3-collaboration/blob/master/grants/grants.md). Essentially, the problems and ideas which we believe to be important will appear on the [issues](https://github.com/w3f/Web3-collaboration/issues) page. It is also possible for project teams to suggest new ideas: to do so simply create a new issue. - -### Polkadot ecosystem issues -Here are some of the important issue areas that we would love for the community to collaborate with us on. - -Development issues: -* Build core technology. -* Test core technology. -* Create general ecosystem components. - -More information on development collaboration can be found in the development collaboration document: [development doc](https://github.com/w3f/Web3-collaboration/blob/master/development.md) - -### Web3 ecosystem issues -Please see our development collaboration document for further details: [development doc](https://github.com/w3f/Web3-collaboration/blob/master/development.md) - -## Who we are looking for -The ideal candidates are people who can work in a self-directed manner and are able to manage their own time and resources in order to hit the necessary targets. For meetups, it is possible to do this single-handedly although for larger coding projects we expect teams of multiple members will be typical. - -The Web3 Foundation is here to provide guidance and cross-team coordination, and in some cases we will be able to provide funding too. - -If these issues are of interest to you then please comment on an open issue, or create a new issue, and provide the relevant information (refer to the submission process guidelines). - -## Submission process guidelines -To help collaborate with us to build the next generation of the web we would be grateful if you could supply the information listed below about you and your team (where applicable). In cases where funding is also required please add information that pertains the additional points listed below. - -### Standard Response Template -Below is a template for responding to issues. If you are offering collaboration help then we would appreciate getting to know the key details as clearly as possible. You are free to modify the template to suit your response, but we are aiming for structured correspondence with the community. - -**Template** - -* What is the plan: -* Number of people on your team: -* Do you need help from W3F: -* Do you need help from the community: - -**Examples** - -If you would like to see some example responses then check out the following document in this repo: [response-examples.md](https://github.com/w3f/Web3-collaboration/blob/master/response-examples.md) - -## Polkadot Meetups -We have multiple active meetup groups across the world. Find more information on the following doc: [Link](https://github.com/w3f/Web3-collaboration/blob/master/meetups.md). We encourage you to note your interest in the [issues](https://github.com/w3f/Web3-collaboration/issues) section of this repo and find collaborators in your local area! - -## Additional information +- [:clipboard: About](#clipboard-about) +- [:bookmark_tabs: Guidelines](#bookmark_tabs-guidelines) + - [Licensing](#licensing) + - [Documentation](#documentation) + - [Who we are interested in funding](#who-we-are-interested-in-funding) +- [:pencil: Process](#pencil-process) +- [:bulb: Help](#bulb-help) + - [Additional information](#additional-information) + - [Real-time conversation](#real-time-conversation) +- [:information_source: License](#information_source-license) + +## :clipboard: About +As part of our commitment to promoting the Web3 ecosystem, we offer a comprehensive grants program focused on funding software development and research efforts related to Polkadot and Substrate. +For more information about the Web3 Foundation please visit the [About page](https://web3.foundation/about/) of our website. + +## :bookmark_tabs: Guidelines +Technical grants are intended to fund **Polkadot** and **Substrate** specific projects in the following areas: + +* software development +* research +* the production of software documentation and technical education material + +For more specific information on our funding priorities, please view the [Polkadot Stack](./grants/polkadot_stack.md) and take a look at the [accepted grant applications](https://github.com/w3f/Web3-collaboration/blob/master/grants/accepted_grant_applications.md). + +The funding maximum for technical grants is $100,000 per project. Teams shouldn’t seek to cover 100% of their early-stage funding via W3F Grants alone. + +Any project requesting : +* **$30k or less** will receive approval the fastest. +* **$31k - 100k** will need to wait longer for a decision. + +Teams can apply for grants more than once, but they need to complete the previous project (as described in their application) before receiving additional funds. + +We are primarily interested in projects that can be completed in **3 months** or less. + +### Licensing +In order to successfully receive grant funding for your application it is necessary for the project to have **open source** code. We prefer Apache 2.0 but the GNU GPL v3 license is also acceptable. + +### Documentation +To ensure ease-of-use we require all projects to create documentation that explains how their project works. At a minimum, written documentation is required for funding. Tutorials or videos are also helpful for new users to understand how to use the product. + +## :pencil: Process +If you are considering applying for a grant, please follow the process below. + +1. **Determine the scope of your project** + * Review the [Polkadot Stack](./grants/polkadot_stack.md) and take a look at the [accepted grant applications](https://github.com/w3f/Web3-collaboration/blob/master/grants/accepted_grant_applications.md). If your idea isn’t listed, but you think it’s cool, you can send us an [email](mailto:grants@web3.foundation) and tell us about it. + * Ensure the scope of your project falls within the [:bookmark_tabs: Guidelines](#bookmark_tabs-guidelines) + + Once you determine that your project falls within the [Polkadot Stack](./grants/polkadot_stack.md) and corresponds to the guidelines above, proceed to the next step. + +1. **Application** + + We recommend checking out the [technical grant template](https://github.com/w3f/Web3-collaboration/blob/master/grants/grant_application_template.md). It gives an indication of what a good roadmap should look like, plus it outlines the criteria of what we look for in an application. + + 1. Fill out the Google form for your grant application by clicking the following link: [:arrow_right: Apply here](https://docs.google.com/forms/d/e/1FAIpQLSfMfjiRmDQDRk-4OhNASM6BAKii7rz_B1jWtbCPkUh6N7M2ww/viewform) + + Partially public applications that limit financial information (e.g. funding amount requested) to the Google form are preferred. However, teams are free to make fully public applications as well as fully private applications. + + Teams that chose to make a fully private application are done once this form is complete. Teams that have chosen to make a fully or partially public application should proceed to the next step. + + 1. Fully or partially public applications should be made via a pull request to this repo by following the steps below. + 1. Fork this repository. + 1. In the newly created fork, create a copy of the [technical grant template](https://github.com/w3f/Web3-collaboration/blob/master/grants/grant_application_template.md). + * Most applications should go into the [speculative](https://github.com/w3f/Web3-collaboration/tree/master/grants/speculative) sub-folder. + * In the few cases where the application is a response to specific RFP then the application should go into the [rfps](https://github.com/w3f/Web3-collaboration/tree/master/grants/rfps) sub-folder. + 1. Label the file as "project_name.md". + 1. Fill out the template with the details of your project. + 1. Once you have completed the application, click on "create new pull request". + 1. The body of the pull request will show a template that requests an abstract of the project and the completion of a checklist. Please complete as appropriate and take care to include all necessary information. The **pull request template** can be viewed [here](https://github.com/w3f/Web3-collaboration/blob/master/.github/PULL_REQUEST_TEMPLATE.md). + +1. **Review** + * The W3F will review the applications received, determine if more information is required and potentially schedule a call with the team. + * Parity Technologies may also assist in the review of some applications. + +1. **Decision** + * The W3F will notify the applicants of whether their proposal has been accepted for grant funding or not. + * If a team is successful, further communication will be required to determine specific details around timelines and payment schedules. + +1. **Follow up** + * Once progress has started, the W3F will want to have follow up conversations to see how the project is progressing. + * To help to speed up the milestone evaluation process, take a look at the [Milestone Deliverables Guidelines](./grants/milestone-deliverables-guidelines.md) + +### Who we are interested in funding + +* Individuals + * Developers, anyone in the community + * Note: all contracts need to be signed with legal entities (e.g. an LLC / Ltd). +* Companies/Teams + * Established teams with a track record +* Researchers + * Universities/Professors + +## :bulb: Help + +### Additional information * [W3F Website](https://web3.foundation) * [W3F Forum](https://forum.web3.foundation) * [W3F Twitter](https://twitter.com/web3foundation) * [W3F Medium](https://medium.com/web3foundation) -* [Web 3.0 Wiki](https://github.com/w3f/Web3-wiki/wiki) +* [Polkadot Wiki](https://wiki.polkadot.network/en/) * [Web 3.0 Reddit](https://www.reddit.com/r/web3) -## Real-time conversation +### Real-time conversation We have Riot channels for real-time discussions on Web3 and Polkadot. Join the conversations. * [Web3 Foundation](https://riot.im/app/#/room/#web3foundation:matrix.org) * [Polkadot Watercooler](https://riot.im/app/#/room/#polkadot-watercooler:matrix.org) +## :information_source: License +[Apache License 2.0](https://github.com/w3f/Web3-collaboration/blob/Noc2-patch-3/LICENSE) © Web3 Foundation diff --git a/development.md b/development.md deleted file mode 100644 index afe023d4d..000000000 --- a/development.md +++ /dev/null @@ -1,44 +0,0 @@ -# Development Collaboration -We welcome developers to engage with us on any development project related to the Web 3 ecosystem, and in particular any development that relates to Polkadot. - -## Polkadot ecosystem issues -Here are some of the important issues that we would love for the community to collaborate with us on: - -Build Core technology: -* [Write and implement new parachains](https://github.com/w3f/Web3-collaboration/issues/11). -* [Create an alternate implementation of Substrate in another language](https://github.com/w3f/Web3-collaboration/issues/12) (e.g. C++, Go). -* Create alternate implementations of the Polkadot nodes (validators, collators) in another language (e.g. C++, Go). - -Test core technology: -* Test the available code by building nodes: e.g. [PoC2](https://github.com/w3f/Web3-collaboration/issues/13). -* Test the available user interfaces and interact with the network. -* Help to find bugs and security vulnerabilities. - -Create general ecosystem components: -* [Create a block explorer](https://github.com/w3f/Web3-collaboration/issues/8). -* [Create a node explorer](https://github.com/w3f/Web3-collaboration/issues/9). -* [Create a wallet](https://github.com/w3f/Web3-collaboration/issues/10). - -## Web3 ecosystem issues -The issues in this section will be better defined in the future. However, to gain an understanding of how we view the Web 3 ecosystem we suggest looking at our proposed [tech stack](https://github.com/w3f/Web3-wiki/wiki/Tech-Stack). We are keen to speak with teams working towards making the [Web 3 vision](https://github.com/w3f/Web3-wiki/wiki/Web3-Mission-and-Background) a reality. - -## Development requirements -If you would like to develop a new parachain or write an alternative implementation of our software, then we would appreciate if you contacted us and have a chat. While it isn't a strict requirement to contact us, we think there is a lot to be gained from having discussion and working together. The following list is a typical set of requirements that we would like to know about you and your team. - -Please provide: - -* Name (lead person), plus team members' names (if relevant) -* Send us an email with the relevant members CC'ed -* GitHub links -* LinkedIn profile links -* Brief description of team's background -* Project Name -* Website -* Project description (brief) -* Project plan/roadmap with relevant milestones - - -If funding is required, please indicate: - -* Plan for use of funds -* Total previous project funding diff --git a/grants/grants.md b/grants/grants.md deleted file mode 100644 index 57bf9c99b..000000000 --- a/grants/grants.md +++ /dev/null @@ -1,164 +0,0 @@ -# Web3 Foundation General Grants Program - -As part of our commitment to promoting the Web3 ecosystem, we offer a comprehensive grants program focused on funding software development, research, technical education and community engagement efforts related to **Polkadot** and **Substrate**. - -For smaller technology grants up to **$30k**, which are tracked **transparently** on GitHub and disbursed in **bitcoin**, see also our new [Open Grants Program](https://github.com/w3f/Open-Grants-Program). - ---- - -- [Process](#process) -- [Guidelines for technical grants](#guidelines-for-technical-grants) - - [Licensing](#licensing) - - [Documentation](#documentation) - - [Areas of interest for technical grants](#areas-of-interest-for-technical-grants) - - [Who we are interested in funding](#who-we-are-interested-in-funding) - -## Process -If you are considering applying for a grant, please follow the process below. - -1. **Determine the scope of your project** - * Review the appropriate areas of interest: - * [Areas of interest for technical grants](#areas-of-interest-for-technical-grants) - * ~~Areas of interest for community engagement grants~~ (the community engagement grants program is currently on-hold) - - If your idea isn’t listed, but you think it’s cool, you can send us an [email](mailto:grants@web3.foundation) and tell us about it. - * Ensure the scope of your project falls within the appropriate guidelines - * [Guidelines for technical grants](#Guidelines-for-technical-grants) - * ~~Guidelines for community engagement grants~~ (the community engagement grants program is currently on-hold) - - Once you determine that your project falls within the areas of interest and corresponds to the guidelines above, proceed to the next step. - -1. **Application** - - We recommend checking out the "[How successfully apply](https://medium.com/web3foundation/web3-foundation-grants-wave-two-recipients-16d9b996501d)" section at the end of the Wave 2 grant winners blog post. It gives an indication of what a good roadmap should look like, plus it outlines the criteria of what we look for in an application. - - 1. Fill out the appropriate Google form for your grant application: - - Partially public applications that limit financial information (e.g. funding amount requested) to the Google form are preferred. However, teams are free to make fully public applications as well as fully private applications. - - * [Apply here for a Technical Grant](https://docs.google.com/forms/d/e/1FAIpQLSfMfjiRmDQDRk-4OhNASM6BAKii7rz_B1jWtbCPkUh6N7M2ww/viewform) - - Teams that chose to make a fully private application are done. Teams that have chosen to make a fully or partially public application should proceed to the next step. - - 1. Fully or partially public applications should be made via a pull request to this repo by following the steps below. - 1. Fork this repository. - 1. In the newly created fork, create a copy of the [technical grant template](https://github.com/w3f/Web3-collaboration/blob/master/grants/grant_application_template.md). - * Most applications should go into the [speculative](https://github.com/w3f/Web3-collaboration/tree/master/grants/speculative) sub-folder. - * In the few cases where the application is a response to specific RFP then the application should go into the [rfps](https://github.com/w3f/Web3-collaboration/tree/master/grants/rfps) sub-folder. - 1. Label the file as "project_name.md". - 1. Fill out the template with the details of your project. - 1. Once you have completed the application, click on "create new pull request". - 1. The body of the pull request will show a template that requests an abstract of the project and the completion of a checklist. Please complete as appropriate and take care to include all necessary information. The **pull request template** can be viewed [here](https://github.com/w3f/Web3-collaboration/blob/master/.github/PULL_REQUEST_TEMPLATE.md). - -1. **Review** - * The W3F will review the applications received, determine if more information is required and potentially schedule a call with the team. - * Parity Technologies may also assist in the review of some applications. - -1. **Decision** - * The W3F will notify the applicants of whether their proposal has been accepted for grant funding or not. - * If a team is successful, further communication will be required to determine specific details around timelines and payment schedules. - -1. **Follow up** - * Once progress has started, the W3F will want to have follow up conversations to see how the project is progressing. - -## Guidelines for technical grants -Technical grants are intended to fund **Polkadot** and **Substrate** specific projects in the following areas: - -* software development -* research -* the production of software documentation and technical education material - -For more specific information on our funding priorities, please view our [areas of interest section](#areas-of-interest-for-technical-grants) below. - -The funding maximum for technical grants is $100,000 per project. Teams shouldn’t seek to cover 100% of their early-stage funding via W3F Grants alone. - -Any project requesting : -* **$30k or less** will receive approval the fastest. -* **$31k - 100k** will need to wait longer for a decision. - -Teams can apply for grants more than once, but they need to complete the previous project (as described in their application) before receiving additional funds. - -We are primarily interested in projects that can be completed in **3 months** or less. - -### Licensing -In order to successfully receive grant funding for your application it is necessary for the project to have **open source** code. We prefer Apache 2.0 but the GNU GPL v3 license is also acceptable. - -### Documentation -To ensure ease-of-use we require all projects to create documentation that explains how their project works. At a minimum, written documentation is required for funding. Tutorials or videos are also helpful for new users to understand how to use the product. - -### Areas of interest for technical grants -The W3F is interested in providing grants within the following areas of interest. If any of these topics are of interest to you then please make a speculative application to request funding for your project. Feel free to also take a look at the [accepted grant applications](https://github.com/w3f/Web3-collaboration/blob/master/grants/accepted_grant_applications.md). - -* **Software development** - * Development and deployment tooling - * IDEs - * Dependency management - * Testing frameworks - * Scalable cluster - * Tools for easy deployment - * Parachain development kits - * Off-chain worker tooling - * New languages and libraries - * Targeting deterministic Wasm in Runtime - * Node API bindings (Besides JS and Java at moment!) - * New chains - * Interesting new blockchains that can act as parachains - * Chains with succinct state transition proofs (i.e. zk-SNARKs or zk-STARKs based) - * Application specific parachains with a good product story - * Adaptations of existing blockchains as parachains - * Protocol integrations - * Bridges to other blockchains ([Link](https://github.com/w3f/Web3-collaboration/issues/155)) - * Ethereum - * Bitcoin - * ZCash - * Tezos - * Cosmos - * Consortium chains - * Distributed File Storage (e.g. IPFS) - * ~~Transient P2P messaging (e.g. Whisper)~~ - * New protocols that are useful for Web3 stack - * Second layer protocols (runtime modules, dedicated parachains) - * State channels - * ~~Plasma~~ - * Key server networks - * Monitoring - * ~~Block explorers~~ - * Node explorers - * Statistical analytics - * UI - * Wallets (including Metamask-like wallets) - * Libraries - * Mobile integration - * ~~Alternative Polkadot Runtime Environment implementation~~ ([Link](https://github.com/w3f/Web3-collaboration/issues/12)) - * Hardware wallet integration / HSMs - * Users, validators and collators - * Polkadot Runtime Modules and corresponding UIs - * Governance - * Interoperability - * Stable coins - * Oracles - * Identity - * General app modules, see [Ethereum paper](https://github.com/ethereum/wiki/wiki/White-Paper#applications) for inspiration - * Benchmarking tools - * Core implementation testing tools -* **Research** - * Benchmarking - * New primitives - * Technical and economical - * Analysis of existing protocols and implementations - * Security testing -* **Education and documentation** - * Software Documentation - * Technical education material - * Courses - * Tutorials - * Guides - -### Who we are interested in funding - -* Individuals - * Developers, anyone in the community -* Companies/Teams - * Established teams with a track record -* Researchers - * Universities/Professors diff --git a/grants/polkadot_stack.md b/grants/polkadot_stack.md new file mode 100644 index 000000000..4b77f8993 --- /dev/null +++ b/grants/polkadot_stack.md @@ -0,0 +1,128 @@ +# Open Source Polkadot Stack [WIP!] + +The goal of this page is to provide an overview of the open-source polkadot tech stack. At the moment it's far from complete. + +--- + +- [:clipboard: About](#clipboard-about) +- [:battery: Funding](#battery-funding) +- [:bookmark_tabs: Layers of Polkadot Stack](#bookmark_tabs-layers-of-polkadot-stack) + - [:iphone: Explorer and Wallets](#iphone-explorer-and-wallets) + - [:wrench: Tools, APIs and Languages](#wrench-tools-apis-and-languages) + - [:link: Chains and Modules](#link-chains-and-modules) + - [:black_circle: Host](#black_circle-host) + - [:electric_plug: Network Maintenance Tools](#electric_plug-network-maintenance-tools) + - [:black_nib: Signatures](#black_nib-signatures) +- [:construction_worker: Contributing](#construction_worker-contributing) + +## :clipboard: About + +Polkadot Stack is a subset of the Web3 Stack, which consists of **open-source** technologies contributing to [Polkadot](https://polkadot.network/), [Kusama](https://kusama.network/) or [Substrate](https://substrate.dev/) (below in stack) or rely on it (above in stack). + +``` +|------|--------|------------| +| DeFi | Gaming | Provenance | +|______|________|____________| + Dapps +|--------------------------/-| +| Browsers, Wallets / | +|------------------------/---| +| Tools, Apis, Languages/ | +|----------------------/-----| +| 2nd layer protocols / | +|--------------------/-------| +| Chains / other | +|------------------/--- --| +| *Polkadot* | tech | +|------------------\---------| +| P2P, Crypto, Wasm \ | +|--------------------\-------| +``` +## :battery: Funding + +If you want to actively contribute to the polkadot stack and you are looking for funding, please make an application via the +[General Grants Program](https://github.com/w3f/Web3-collaboration/blob/master/grants/grants.md) +or [Open Grants Program](https://github.com/w3f/Open-Grants-Program). Keep in mind that we are generally interested in funding more than one solution for a specific field. Also, we have an interest in keeping existing technology up to date, in case older projects are no longer maintained. + +## :bookmark_tabs: Layers of Polkadot Stack + +In the below sections you can find a list of different layers of the Polkadot Stack. + +### :iphone: Explorer and Wallets + +| Need | Existing Projects +|-|- +| Desktop Wallets | [AirGap](https://github.com/airgap-it/airgap-wallet) +| Browser Extensions | [Polkadot{.js}](https://github.com/polkadot-js/extension), [Enzyme](https://getenzyme.dev/), [Speckle OS](https://www.speckleos.io/) +| Mobile Wallets| [Lunie](http://lunie.io/), [Polkawallet](https://polkawallet.io/), [Parity Signer](https://github.com/paritytech/parity-signer) +| Web (burner) Wallets| +| Multisignature Wallets| +| Hardware Wallets | [Ledger](https://github.com/ZondaX/ledger-polkadot), [NGRAVE](https://ngrave.io/) +| Explorer | [Polkascan](https://github.com/polkascan), [Polkastats](https://polkastats.io/) +| Validator Dashboard | [DotHub](https://github.com/figment-networks/dothub), [Polkacube](https://github.com/hashquark-io) + +### :wrench: Tools APIs and Languages + +| Need | Existing Projects +|-|- +| Parachain Dev Kits | [Gantree](https://github.com/flex-dapps)| +| Polkadot RPC clients | [Go](https://github.com/centrifuge/go-substrate-rpc-client), [.Net](https://github.com/usetech-llc/polkadot_api_dotnet), [C++](https://github.com/usetech-llc/polkadot_api_cpp), [Haskell](https://github.com/Pixura), [Javascript](https://github.com/polkadot-js/api), [Ruby](https://github.com/itering/scale.rb), [Python](https://github.com/polkascan/substrate-interface-api), [Java](https://github.com/polkadot-java) +| Easy Runtime Development | [VS Plugin](https://github.com/everstake/vscode-plugin-substrate), [Atom Code Plugin](https://github.com/everstake/atom-plugin-substrate), [Substrate Playground](https://github.com/paritytech/substrate-playground) +| Easy Smart Contract Development | [ink-playground](https://github.com/staketechnologies/ink-playground/tree/master), [Ink! Remix Plugin](https://github.com/blockchain-it-hr/ink-remix-plugin) +| Runtime Security | [K specifications](https://github.com/kframework/wasm-semantics) +| Smart Contract Languages | [Solang](https://github.com/hyperledger-labs/solang), [Ink!](https://github.com/paritytech/ink), [Pact](https://github.com/kadena-io/) +| Smart Contract Security | +| Easy integration testing | +| Performance Testing | + +### :link: Chains and Modules + +| Need | Existing Projects +|-|- +| Scalable Transactions | [Plasm](https://github.com/staketechnologies/Plasm), [Celer](https://github.com/celer-network), [Gunclear](https://github.com/GunClear) +| Bridges| [Ethereum by Centrifuge](https://github.com/centrifuge/), [EOS by Bifrost](https://github.com/bifrost-codes) +| Privacy | [ZeroChain](https://github.com/LayerXcom/zero-chain), [pLibra](https://github.com/libra-china-org) +| Off-Chain | [substraTEE](https://github.com/scs/substraTEE) +| Financial Chains | [Laminar Chain](https://github.com/laminar-protocol/laminar-chain), [Acala](https://acala.network/), [Centrifuge](https://github.com/centrifuge/), [Stafi](https://github.com/stafiprotocol/stafi-node) +| Smart contract chains | [Edgeware](https://github.com/hicommonwealth) +| Access to real world data | [Oracle by Laminar](https://github.com/laminar-protocol/open-runtime-module-library/tree/master/oracle) +| Identity | [Caelum Labs](https://gitlab.com/caelum-tech/lorena) +| Verifiable Claims | [KILT](https://github.com/KILTprotocol) +| Supply chain| [Wiv](https://github.com/wivtech/Substrate-SupplyChain) +| Social Networking | [SubSocial](https://github.com/dappforce/dappforce-subsocial) +| File Storage | [DatDot](https://github.com/playproject-io/datdot) +| Computation | +| Enable specific use-cases | [Robonomics](https://github.com/airalab/substrate-node-robonomics) + +### :black_circle: Host + +| Need | Existing Projects +|-|- +| Rust | [Substrate](https://github.com/paritytech/substrate) +| C++ | [Kagome](https://github.com/soramitsu/kagome) +| Go | [Gossamer](https://github.com/ChainSafe/gossamer) +| AssemblyScript | + +### :electric_plug: Network Maintenance Tools + +| Need | Existing Projects +|-|- +| Secure validator setup | [Trutzone-based HSM](https://github.com/ZondaX) +| Deployment Tools| [Polkadot Package Manager](https://github.com/Blockdaemon/bpm-sdk), [PolkaHub](https://github.com/akropolisio/polkahub-monorepo) +| Validator monitoring | [P.A.N.I.C.](https://github.com/SimplyVC/panic_polkadot), [Polkalert](https://github.com/galacticcouncil/polkalert), [B-Harvest](https://github.com/nodebreaker0-0/substrate/tree/prometheus_v0.3) + +### :black_nib: Signatures + +| Need | Existing Projects +|-|- +| SR25519 | [C](https://github.com/usetech-llc/sr25519), [C#](https://github.com/usetech-llc/sr25519_dotnet) +| Easy multisig scheme | + + +## :construction_worker: Contributing + +Pull requests, issues, or other contributions from the community are encouraged! You can not only add specific projects but also potentially interesting fields/areas, which are currently missing in the tech stack. + +:heavy_exclamation_mark: All technologies listed above need to be open-source. Ideally, the links lead directly to the code. + +_Note: You will need a GitHub account to suggest changes or file issues. If you do not have a GitHub account, you may [sign up for one for free](https://github.com/join)._ diff --git a/meetups.md b/meetups.md deleted file mode 100644 index 643c58e49..000000000 --- a/meetups.md +++ /dev/null @@ -1,76 +0,0 @@ -# Host a Polkadot & Web 3 Community Meetup -This guide has the goal of getting you set up best on hosting your first Web 3 community meetups. The Web 3 community can host, source funding, acquire swag, and learn how to host your own Meetup or workshop here. This guide covers the main steps you need to get your own meetup off the ground. - -**There are 4 main steps to consider.** -1. [Applying to Run a Meetup](#apply) -2. [Planning & Organization](#planning) -3. [Hosting your Meetup](#host) -4. [Post event Feedback](#post) - - -## Applying to run a meetup - -**Apply to organize a meetup** [here](https://airtable.com/shrl0S6GoqkSozR7C) - - -## Planning & Organization - -**A. Fundamental steps (co-founders of meetup) & Budget** - -
    i. The first step to a successful (recurring) meetup in ensuring you have a solid team of co-founders to help carry the weight. It’s crucial if you intend to continually grow a community around a meetup to select a dedicated crew to help out with the organization, planning, promotion, food & drinks etc. It’s also best to ahead of time agree on certain aspects (eg. food planner, A/V guy, marketing) you’ll be responsible for at the planning for each meetup. - - ii. The next most important thing to consider is budget, most meetup planning starts 4-6 weeks before the meetup, and it’s suggested to get your meetup page live at least 3 weeks before the actual date so you can estimate successfully the amount of food & drinks. Consider that most meetups have 50-70% attendance on the final RSVP #’s so keep the budget in mind for that. - - iii. Many times the event space can be provided in locations for free, if you need help finding an event location some good resources are usually, universities, entrepreneur centers & social locations. Meetup.com provides a good resource on this topic. -
- - -**B. Speakers & or materials needed (for presentations)** - -
    i.Consider who your speaker will be and find out what presentation materials they may need. In many cases a presenter may be comfortable creating their own materials, templated resources are also provided for custom materials. -
- -**C. Marketing & signups (what platform will you use)** - -
    i.For marketing you may consider reaching out to local community groups that you are connected with in your region, many times other meetups in your area can be a great resource for new growth of your meetup. - -ii.Make sure your messaging is concise in clear in what the goals of the meetup are, eg. is this a group that intends to run / host multiple meetups; or are you just getting your feet wet with a one-off event. Also consider who the main audience for your meetup topic may be. -
- -**D. Timelines & Agenda** - -
    i.In practice it’s best to plan your meetup at least 6 weeks ahead of time. You’ll want to announce your meetup at least 3 weeks before the event, so you’ll be able to plan the food & drinks in advance.
- - -## Hosting your meetup/s - -**A. Signs & materials** - -*Make sure your meetup is easy to find! If your venue may not be in plain view from the street/posted address, please post directional signs around the vicinity to ensure everyone’s arrival. - - -**B. Food & beverage** - -We typically see pizza and beer as the standard at our meetups, but whenever available, we encourage local specialties! For example, we offered various local Chinese delicacies at our recent meetups around mainland China, just as we offered top-notch Mission district tacos at our recent meetup in San Francisco. - -Altogether, plan to organize enough food for your expected RSVPs, but providing a feast is not necessary. - - -**C. A/V** -Whenever possible, we encourage co-organizers to collect slides from presenters at least a few days in advance. This allows the co-organizer to upload all presentation materials to a platform like Google drive, so the transitions between speakers can be quick and efficient. - -When this isn’t possible, it is important to make sure that the venue offers all standard A/V assets (HDMI, USB-C, or any Thunderbolt adapters). Speakers should prepare their slides or any visual materials in a 16:9 format to maintain consistency across presentations over the course of the event. - - -**D. Available Presentation / Design assets for the community** - -Polkadot template presentation: [here](https://docs.google.com/presentation/d/1mJRdIbddrmn9lemhh2yqjXY6BglxrzmZBG1wxl_gdvo/edit?usp=sharing) - -Substrate template presentation: [here](https://docs.google.com/presentation/d/1dhaoLb5V2K_vDe4EJlUcKwePD1nMktr57fOdSo8bHns/edit#slide=id.g45ee0ba2ab_3_12) - -[Polkadot Logos found here .ZIP file](https://polkadot.network/brand) - -## Post-event feedback -After your event you can consider leaving feedback for how your experience was working with us and what we could do to help improve your meetup going off without a hitch! -[here](https://airtable.com/shr44bEJL7fMpiaSG) - diff --git a/response-examples.md b/response-examples.md deleted file mode 100644 index 1d21db61e..000000000 --- a/response-examples.md +++ /dev/null @@ -1,38 +0,0 @@ -# Issue Response Template and Examples - -As mentioned in this repo's [readme](https://github.com/w3f/Web3-collaboration), we would appreciate structure feedback to the [issues](https://github.com/w3f/Web3-collaboration/issues) in this repo. - -Below is an template that provides an example of how we would like a response. Your reply does not have to perfectly mirror this, and we would be happy to have you expand upon this template if necessary. - - -## Standard Response Template -You are free to modify the template to suit your response, but we are aiming for structured correspondence with the community. - -**Template** - -* What is the plan: -* Number of people on your team: -* Do you need help from W3F: -* Do you need help from the community: - - -## Example Issue Responses - -### Example 1 - Hosting a Polkadot meetup - -Here is an example response to hosting a meetup in Berlin ([issue #2](https://github.com/w3f/Web3-collaboration/issues/2)) - -* **What is the plan**: We plan to host a meetup in Berlin. Our target date is late October. -* **How many people**: Me plus 1 more (this is to give an indication of the *size of the organising team* - naturally it is hoped that the event will be popular and have many people. If you can estimate the latter, feel free to indicate this). -* **Do you need help from W3F**: It would be great if you could help us market to the whole community. Presentation material would also really help us, so we don't have to create it from scratch. Do you think it would be possible to send a developer to present at one of our meetup events? -* **Do you need help from the community**: Nothing at this time, but help with promotion would be great, plus we would love for as many people as possible to attend. - - -### Example 2 - creating an open source block explorer - -This is inspired by Emiel's reply to [issue #8](https://github.com/w3f/Web3-collaboration/issues/8) - -* **What is the plan**: We have been working on a block explorer for other chains, and now want to create one for Polkadot. -* **How many people**: Just me. -* **Do you need help from W3F**: Help to engage in discussion with the developers at Parity. -* **Do you need help from the community**: Nothing at the moment.