Skip to content

Latest commit

 

History

History
110 lines (83 loc) · 6.88 KB

application-template.md

File metadata and controls

110 lines (83 loc) · 6.88 KB

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 on how to submit a proposal.

  • 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.

Project Overview 📄

If this application in response to an RFP then please indicate this on the first line of this section.

Overview

Please provide the following:

  • A brief description of the project.
  • An indication of how you will integrate this project 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.

Therefore, we ask the teams to submit (where relevant):

  • Mockups/designs of any UI components
  • 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
  • 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?

Team 👥

Team members

  • Name of team leader
  • Names of team members

Contact

  • Contact Name: Full name of the contact person (e.g. John Brown)
  • Contact Email: Contact email (e.g. john@duo.com)
  • 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 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.

Team Code Repos

Team LinkedIn Profiles

Development Roadmap 🔩

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.

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.

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.
  • 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)

Overview

  • Total Estimated Duration: Duration of the whole project (e.g. 2 months)
  • Full-time equivalent (FTE): Workload of an employed person (see) (e.g. 2 FTE)
  • Total Costs: Amount of Payment in BTC or DAI 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. 0.80 BTC)

Milestone 1 Example — Implement Substrate Modules

  • Estimated Duration: 1 month
  • FTE: 1
  • Costs: 0.75 BTC
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
0d. Article/Tutorial We will write an article or tutorial that explains the work done as part of the grant.
1. Substrate module: X We will create a Substrate module that will... (Please list the functionality that will be coded for the first milestone)
2. Substrate module: Y We will create a Substrate module that will...
3. Substrate module: Z We will create a Substrate module that will...
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.

Additional Information ➕

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?