-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cleaned up the template to mention things only once, ❗ for everything that is constantly ignored.
- Loading branch information
Showing
1 changed file
with
9 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,7 +8,7 @@ | |
- **Payment Address:** BTC, Ethereum (USDT/USDC/DAI) or Polkadot/Kusama (aUSD) payment address. Please also specify the currency. (e.g. 0x8920... (DAI)) | ||
- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 1, 2 or 3 | ||
|
||
> ⚠️ *The combination of your GitHub account submitting the application and the payment address above will be your unique identifier during the program. Please keep them safe.* | ||
> :exclamation: *The combination of your GitHub account submitting the application and the payment address above will be your unique identifier during the program. Please keep them safe.* | ||
## Project Overview :page_facing_up: | ||
|
||
|
@@ -64,7 +64,7 @@ Help us locate your project in the Polkadot/Substrate/Kusama landscape and what | |
|
||
- **Contact Name:** Full name of the contact person in your team | ||
- **Contact Email:** Contact email (e.g. [email protected]) | ||
- **Website:** | ||
- **Website:** Your website | ||
|
||
### Legal Structure | ||
|
||
|
@@ -79,7 +79,6 @@ If anyone on your team has applied for a grant at the Web3 Foundation previously | |
|
||
### Team Code Repos | ||
|
||
- https://github.com/<your_organisation> | ||
- https://github.com/<your_organisation>/<project_1> | ||
- https://github.com/<your_organisation>/<project_2> | ||
|
||
|
@@ -109,17 +108,7 @@ This section should break the development roadmap down into milestones and deliv | |
|
||
Below we provide an **example roadmap**. In the descriptions, it should be clear how your project is related to Substrate, Kusama or Polkadot. We _recommend_ that teams structure their roadmap as 1 milestone ≈ 1 month. | ||
|
||
For each milestone, | ||
|
||
- make sure to include a specification of your software. _Treat it as a contract_; the level of detail must be enough to later verify that the software meets the specification. | ||
- include the amount of funding requested _per milestone_. | ||
- include documentation (tutorials, API specifications, architecture diagrams, whatever is appropriate) in each milestone. This ensures that the code can be widely used by the community. | ||
- provide a test suite, comprising unit and integration tests, along with a guide on how to set up and run them. | ||
- commit to providing Dockerfiles for the delivery of your project. | ||
- indicate milestone duration as well as number of full-time employees working on each milestone. | ||
- **Deliverables 0a-0d are mandatory for all milestones**, and deliverable 0e at least for the last one. If you do not intend to deliver one of these, please state a reason in its specification (e.g. Milestone X is research oriented and as such there is no code to test). | ||
|
||
> :zap: If any of your deliverables is based on somebody else's work, make sure you work and publish _under the terms of the license_ of the respective project and that you **highlight this fact in your milestone documentation** and in the source code if applicable! **Teams that submit others' work without attributing it will be immediately terminated.** | ||
> :exclamation: If any of your deliverables is based on somebody else's work, make sure you work and publish _under the terms of the license_ of the respective project and that you **highlight this fact in your milestone documentation** and in the source code if applicable! **Teams that submit others' work without attributing it will be immediately terminated.** | ||
### Overview | ||
|
||
|
@@ -133,12 +122,14 @@ For each milestone, | |
- **FTE:** 1,5 | ||
- **Costs:** 8,000 USD | ||
|
||
> :exclamation: **The default deliverables 0a-0d below are mandatory for all milestones**, and deliverable 0e at least for the last one. If you do not intend to deliver one of these, please state a reason in its specification (e.g. Milestone X is research oriented and as such there is no code to test). | ||
| Number | Deliverable | Specification | | ||
| -----: | ----------- | ------------- | | ||
| 0a. | License | Apache 2.0 / GPLv3 / MIT / Unlicense | | ||
| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) spin up one of our Substrate nodes and send test transactions, which will show how the new functionality works. | | ||
| 0c. | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | ||
| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. | | ||
| **0a.** | License | Apache 2.0 / GPLv3 / MIT / Unlicense | | ||
| **0b.** | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) spin up one of our Substrate nodes and send test transactions, which will show how the new functionality works. | | ||
| **0c.** | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | ||
| **0d.** | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. | | ||
| 0e. | Article | We will publish an **article**/workshop that explains [...] (what was done/achieved as part of the grant). (Content, language and medium should reflect your target audience described above.) | | ||
| 1. | Substrate module: X | We will create a Substrate module that will... (Please list the functionality that will be implemented for the first milestone. You can refer to details provided in previous sections.) | | ||
| 2. | Substrate module: Y | The Y Substrate module will... | | ||
|