FIO Development Guide

This document outlines the FIO development process and artifacts at a summary level. See individual artifacts for more detail.

Community dev hub

Several development artifacts are kept on the FIO Developers section of the Dev Hub. These artifacts support developers who are working in FIO repositories.

These include:

• The versioning guide for fio, fio.contracts, the API, and the SDKs

• The Git Branching and Release strategy used by FIO

• The FIO Contract Development process overview

• The Calculating RAM guidelines

• Overview of Developer Tools

• The Devnet Testing guide

Feature Development

This section describes the FIP/Feature development process. The goal is to clearly define the areas of responsibility and the tasks required to get a FIP to development complete.

This process assumes several roles:

• Product Manager (Prod) - This role is responsible for defining the FIP and acting as the end user for acceptance testing.

• Project Manager (PM) - This role is responsible for setting up the development artifacts and monitoring the progress of the FIP through the different stages of development and QA.

• Developer (Dev) - This role is responsible for all development related tasks.

• Quality Assurance (QA) - This role is responsible for all QA related tasks.

The general process for FIP development is defined by several artifacts and proceeds as follows.

1. A FIP is proposed and accepted by the community and the development team has accepted the FIP into its queue

2. The PM copies the FIP Milestone Checklist into a new directory in the Development Documents wiki

3. The PM creates epics, stories, and subtasks for all tasks in the checklist. See the FIP-39 Epic for what this might look like.

4. The development and QA process proceeds in the general order of the checklist, though exact order is up to the PM, Dev, and QA.

5. There are several artifacts described in the checklist that are used to collect information during the development lifecycle. These include:

   1. Development Spec

   2. RAM Usage analysis

   3. Testing guide

   4. Performance and scaling tests

   5. Deployment and rollout Guide

6. Once is the product manager has completed UAT, the FIP is ready to be bundled into a release (see next section).

Release

This section describes the release process. A release may consist of one or more bugs, FIPs, or hot fixes depending on the circumstance.

This process assumes several roles. Note that one individual may serve multiple roles. For example, the Release Manager may take on the release Project Management tasks.

• Project Manager (PM) - This role is responsible for setting up the release artifacts and monitoring the progress of the release through the various stages.

• Release Manager (Release) - This role is responsible for all release tasks.

• Quality Assurance (QA) - This role is responsible for all QA related release tasks.

• Block Producers - The custodians of the chain.

The general process for FIP releases is defined by several artifacts and proceeds as follows.

1. A Release is proposed and accepted by the block producers and the technology team

2. The PM copies the Release Checklist into a new directory in the Releases wiki

3. The PM creates epics, stories, and subtasks for all tasks in the checklist.

4. The release process proceeds in the general order of the checklist, though exact order is up to the Release Manager.