Skip to content

Commit

Permalink
Create application-template.md (#276)
Browse files Browse the repository at this point in the history
* Create application-template.md

- Some clarifications and highlighting based on past issues,
- mention licensing,
- more emojis ✊,
- ask for 
  - short and long term plans,
  - community & contributors,
  - status of project before grant,
  - previous grant applications,
  - work done.

* Apply suggestions from code review

Co-authored-by: Aleixo Sánchez <15819210+alxs@users.noreply.github.com>

* Update applications/application-template.md

Co-authored-by: Aleixo Sánchez <15819210+alxs@users.noreply.github.com>

Co-authored-by: David Hawig <davidhawig@gmail.com>
Co-authored-by: Aleixo Sánchez <15819210+alxs@users.noreply.github.com>
  • Loading branch information
3 people authored Feb 24, 2021
1 parent 0567b13 commit 26e1f49
Showing 1 changed file with 63 additions and 31 deletions.
94 changes: 63 additions & 31 deletions applications/application-template.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,45 @@
# Open Grant Proposal
# W3F Open Grant Proposal

> This document is referenced in the terms and conditions and therefore needs to contain all the required information. Don't remove any of the mandatory parts presented in bold letters or as headlines! See the [Open Grants Program Process](https://github.com/w3f/Open-Grants-Program/blob/master/README_2.md) on how to submit a proposal.
> This document will be part of the terms and conditions of your agreement and therefore needs to contain all the required information about the project. Don't remove any of the mandatory parts presented in bold letters or as headlines! Lines starting with a `>` (such as this one) can be removed.
>
> See the [Open Grants Program Process](https://github.com/w3f/Open-Grants-Program/#pencil-process) on how to submit a proposal.
> This page is also available in [Chinese (中文)](./application-template-cn.md).
> 🌏 This page is also available in [Chinese (中文)](./application-template-cn.md).
* **Project Name:** Name of your project (e.g. DuoSwap Module)
* **Team Name:** Legal name of your team (e.g. Duo)
* **Payment Address:** BTC or Ethereum (DAI) payment address. We don't accept payments for the program in other currencies at this stage. (e.g. 123mp123...)

*The above combination of your GitHub account submitting the application and payment address will be your unique identifier during the program. Please keep them safe.*

> ⚠️ *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:
If this application in response to an RFP then please indicate this on the first line of this section.

### Overview

Please provide the following:
* If the name of the project is not descriptive, a tag line (one sentence summary) of the project.
* A brief description of the project.
* An indication of how you will integrate this project into Substrate / Polkadot / Kusama.
* An indication of how the project relates to / integrates into Substrate / Polkadot / Kusama.
* An indication of why your team is interested in creating this project.

### Project Details
We expect the teams to already have a solid idea about the project's expected final state.
We expect the teams to already have a solid idea about the project's expected final state. Therefore, we ask the teams to submit (where relevant):

Therefore, we ask the teams to submit (where relevant):
* Mockups/designs of any UI components
* API specifications of the core functionality
* Data models / API specifications of the core functionality
* An overview of the technology stack to be used
* Documentation of core components, protocols, architecture etc. to be deployed
* Documentation of core components, protocols, architecture, etc. to be deployed
* PoC/MVP or other relevant prior work or research on the topic

### Ecosystem Fit
Are there any other projects similar to yours? If so, how is your project different?

* Where and how does the project fit into the ecosystem?
* What need(s) does the project meet?
* Are there any other projects similar to yours in the Substrate / Polkadot / Kusama ecosystem?
* If so, how is your project different?
* If not, are there similar projects in related ecosystems?

## Team :busts_in_silhouette:

Expand All @@ -40,16 +48,18 @@ Are there any other projects similar to yours? If so, how is your project differ
* Names of team members

### Contact
* **Contact Name:** Full name of the contact person (e.g. John Brown)
* **Contact Name:** Full name of the contact person in your team
* **Contact Email:** Contact email (e.g. john@duo.com)
* Website
* **Website:**

### Legal Structure
* **Registered Address:** Address of your registered legal entity, if available. Please keep it on one line. (e.g. High Street 1, London LK1 234, UK)
* **Registered Address:** Address of your registered legal entity, if available. Please keep it in a single line. (e.g. High Street 1, London LK1 234, UK)
* **Registered Legal Entity:** Name of your registered legal entity, if available. (e.g. Duo Ltd.)

### Team's experience
Please describe the team's relevant experience. If the project involves development work, then we'd appreciated if you can single out a few interesting code commits made by team members on their past projects. For research-related grants, references to past publications and projects in a related domain are helpful.
Please describe the team's relevant experience. If the project involves development work, we would appreciate it if you singled out a few interesting code commits made by team members in past projects. For research-related grants, references to past publications and projects in a related domain are helpful.

If anyone on your team has applied for a grant at the Web3 Foundation previously, please list the name of the project and legal entity here.

### Team Code Repos
* https://github.com/<your_repo_1>
Expand All @@ -59,34 +69,47 @@ Please describe the team's relevant experience. If the project involves develop
* https://www.linkedin.com/<person_1>
* https://www.linkedin.com/<person_2>

## Development Status :open_book:

If you've already started implementing your project or it is part of a larger repository, please provide a link and a description of the code here. In any case, please provide some documentation on the research and other work you have conducted before applying. This could be:

- links to improvement proposals or [RFPs](https://github.com/w3f/General-Grants-Program/tree/master/rfp-proposal) (requests for proposal),
- academic publications relevant to the problem,
- links to your research diary, blog posts, articles, forum discussions or open GitHub issues,
- references to conversations you might have had related to this project with anyone from the Web3 Foundation,
- previous interface iterations, such as mock-ups and wireframes.

## Development Roadmap :nut_and_bolt:

This section should break out the development roadmap into a number of milestones. Since the milestones will appear in the grant contract, it helps to describe the functionality we should expect, plus how we can check that such functionality exists in the product. Whenever milestones are delivered, we refer to the contract to ensure that everything has been delivered as expected.
This section should break the development roadmap down into milestones and deliverables. Since these will be part of the agreement, it helps to describe _the functionality we should expect in as much detail as possible_, plus how we can verify and test that functionality. Whenever milestones are delivered, we refer to this document to ensure that everything has been delivered as expected.

Below we provide an **example roadmap**. In the descriptions, it should be clear how the project is related to Substrate, Kusama or Polkadot. We _recommend_ that the scope of the work can fit within a three-month period and that teams structure their roadmap as 1 milestone ≈ 1 month.

For each milestone,

Below we provide an **example roadmap**. In the descriptions it should be clear how the project is related to Substrate and/or Polkadot. We recommend that the scope of the work can fit within a 3 month period and that teams structure their roadmap as 1 month = 1 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.
To assist you in defining it, we have created a document with examples for some grant categories [here](../src/grant_guidelines_per_category.md).
* 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, and include the approximate number of days along with the cost per day.
* _Deliverables 0a-0d are mandatory_ and shall not be removed, unless you explicitly specify a reason within the PR's `Additional Notes` section (e.g. Milestone X is research oriented and as such there is no code to test).

For each milestone:
* Please be 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.
To assist you in defining it, we created a document with examples for some grant categories [here](../src/grant_guidelines_per_category.md).
* Please include total amount of funding requested per milestone.
* Please note that we require documentation (e.g. tutorials, API specifications, architecture details) in each milestone. This ensures that the code can be widely used by the community.
* Please provide a test suite, comprising unit and integration tests, along with a guide on how to run these.
* Please commit to providing a dockerfiles for the delivery of your project.
* Please indicate the milestone duration, as well as number of Full-Time Employees working on each milestone, and include the number of days along with their cost per day.
* Deliverables 0a-0d are mandatory and should not be removed, unless you explicitly specify a reason within the PR's `Additional Notes` section (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.**
### Overview
* **Total Estimated Duration:** Duration of the whole project (e.g. 2 months)
* **Full-time equivalent (FTE):** Workload of an employed person ([see](https://en.wikipedia.org/wiki/Full-time_equivalent)) (e.g. 2 FTE)
* **Total Costs:** Amount of Payment in USD for the whole project. The total amount of funding needs to be below $30k for initial grants and $100k for follow-up grants at the time of submission. (e.g. 1.000 USD)
* **Full-Time Equivalent (FTE):** Required workload of a full-time employee for the whole project (see [Wikipedia](https://en.wikipedia.org/wiki/Full-time_equivalent)) (e.g. 2 FTE)
* **Total Costs:** Amount of payment in USD for the whole project. The total amount of funding _needs to be below $30k for initial grants_ and $100k for follow-up grants. (e.g. 12,000 USD)

### Milestone 1 Example — Implement Substrate Modules
* **Estimated Duration:** 1 month
* **FTE:** 1
* **Costs:** 1.000 USD

| Number | Deliverable | Specification |
| ------------- | ------------- | ------------- |
| -----: | ----------- | ------------- |
| 0a. | License | Apache 2.0 / 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. Once the node is up, it will be possible to send test transactions that will show how the new functionality works. |
| 0c. | Testing Guide | The code will have unit-test coverage (min. 70%) to ensure functionality and robustness. In the guide we will describe how to run these tests |
Expand All @@ -97,16 +120,25 @@ To assist you in defining it, we created a document with examples for some grant
| 4. | Substrate chain | Modules X, Y & Z of our custom chain will interact in such a way... (Please describe the deliverable here as detailed as possible) |
| 5. | Docker | We will provide a dockerfile to demonstrate the full functionality of our chain |


### Milestone 2 Example — Additional features

...


## Future Plans
Please include the team's long-term plans and intentions.

Please include here

- how you intend to use, enhance, promote and support the project in the short term, and
- the team's long-term plans and intentions in conjunction with the project.


## Additional Information :heavy_plus_sign:

Any additional information that you think is relevant to this application that hasn't already been included.

Possible additional information to include:
* What work has been done so far?

* Are there are any teams who have already contributed (financially) to the project?
* Have you applied for other grants so far?
* Do you have a community of users or open-source developers who are contributing to the project?

0 comments on commit 26e1f49

Please sign in to comment.