Skip to content

Latest commit

 

History

History
128 lines (88 loc) · 6.71 KB

application_template.md

File metadata and controls

128 lines (88 loc) · 6.71 KB
Raw

Crust Grant Proposal

  • Project Name: Name of your project
  • Team Name: Legal name of your team
  • Payment Address: Ethereum address
  • Receivable Token: CRU or USDT

⚠️ 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.

⚠️ When you submit an application for a Grant，You confirm that you have read these Terms and Conditions carefully and that you agree to be bound by them.

Overview

Please provide the following:

  • A project name
  • A brief description of your project.
  • An indication of how your project relates to / integrates into Crust.
  • 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 your project's expected final state. Therefore, we ask the teams to submit (with urls or IPFS file CIDs included) at following :

  • Mockups/designs of any UI components
  • 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
  • PoC/MVP or other relevant prior work or research on the topic

Ecosystem Fit

Help us locate your project in the Crust landscape and what problems it tries to solve by answering each of these questions:

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

Team

Team members

  • Name of team leader
  • Names of team members

Contact

  • Contact Name: Full name of the contact person in your team
  • Contact Email: Contact email (e.g. [email protected])
  • Website:

Legal Structure

  • Registered Address: Address of your registered legal entity, if available. Please keep it in a single line.
  • Registered Legal Entity: Name of your registered legal entity, if available.

Team's experience

Please describe the team's relevant experience. If your 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.

Team Code Repos

Team LinkedIn Profiles

Development Roadmap

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 your project is related to IPFS/Crust. 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,

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

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): Required workload of a full-time employee for the whole project (see Wikipedia) (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 (e.g. 12,000 USD)

Milestone 1 Example — Implement Crust Order Modules

  • Estimated Duration: 1 month
  • FTE: 2
  • Costs: 8,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 Crust 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 Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests.
1. Crust module: X We will create a Crust module that will... (Please list the functionality that will be coded for the first milestone)
2. Crust module: Y We will create a Crust module that will...
3. Crust module: Z We will create a Crust module that will...

Milestone 2 Example — Additional features

  • Estimated Duration: 1 month
  • FTE: 1
  • Costs: 4,000 USD

...

Future Plans

Please include here

  • how you intend to use, enhance, promote and support your project in the short term, and
  • the team's long-term plans and intentions in relation to it.

Additional Information

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

Possible additional information to include:

  • Are there are any teams who have already contributed (financially) to your project?
  • Do you have a community of users or open-source developers who are contributing to your project?