Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add Roadmap #1

Merged
merged 3 commits into from
Oct 26, 2022
Merged

docs: add Roadmap #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
28836f3
docs: add Roadmap
tinytb Oct 26, 2022
3aa7fb3
Update ROADMAP.md
BigLep Oct 26, 2022
fbab96b
Update ROADMAP.md
BigLep Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Roadmap <!-- omit in toc -->

This project is creating a focused, modular, opinionated, JavaScript-native implementation of [IPFS](https://ipfs.tech/) (the Interplanetary File System).

Our goal is a high-quality implementation of the IPFS protocol in TypeScript/JavaScript. It shall run in web browsers, in service workers, in browser extensions, in Node.js, and virtually everywhere else JS runs.

```
Date: 2022-10-26
Status: Draft
Notes: Maintainers have aligned on this roadmap. Please add any feedback or questions in:
https://github.com/ipfs/pomegranate/issues/5
```

## Table of Contents <!-- omit in toc -->

- [🛣️ Milestones](#️-milestones)
- [2022](#2022)
- [Mid Q4 (November)](#mid-q4-november)
- [Late Q4 (December)](#late-q4-december)
- [2023](#2023)
- [Early Q1 (January)](#early-q1-january)
- [Late Q1 (March)](#late-q1-march)
- [Q2](#q2)
tinytb marked this conversation as resolved.
Show resolved Hide resolved

## 🛣️ Milestones
### 2022

#### Mid Q4 (November)

Communicate the IPFS-in-JS state.
tinytb marked this conversation as resolved.
Show resolved Hide resolved

**Problem to solve:** Currently, very few know the direction for IPFS-in-JS and how they can best help. This affects project resourcing, recruiting, and IPFS adoption in general.

**Done state:**
- Present and share the IPFS Camp 2022 presentation.
- Write and publish a blog post.
- Hold a community vote and communication about a name for the new IPFS-in-JS implementation.
tinytb marked this conversation as resolved.
Show resolved Hide resolved

#### Late Q4 (December)

Double team capacity.

**Problem to solve:** Currently, the IPFS-in-JS effort has less than one full-time SWE (Software Engineer) who is also splitting time with js-libp2p.

**Done state:** Accepted offer for 1-2 additional full-time engineers.

**Why:** Extra hands are needed for designing, planning, and executing on IPFS-in-JS. Even if we outsource development, help is needed to review and guide the development work.

### 2023

#### Early Q1 (January)

Finalize "Pomegranate" execution plan. ("Pomegranate" is the temporary codename for the new IPFS-in-JS implementation.)

- Project scope, milestones, success criteria, and communication channels are established.
- Community can follow along and contribute to "Pomegranate".

#### Late Q1 (March)

"Pomegranate" "v1" released.

- Users can add and get files.
- Packaging, publishing, testing, CI/CD, etc. are all set up.
BigLep marked this conversation as resolved.
Show resolved Hide resolved

Tracking issue: https://github.com/ipfs/pomegranate/issues/2

#### Q2

After "Pomegranate" is functional and users can adopt it, Protocol Labs EngRes ceases maintaining the legacy js-ipfs project.