https://github.com/status-im/specs

Specifications for Status clients.
https://github.com/status-im/specs

website

Last synced: about 2 months ago
JSON representation

Specifications for Status clients.

• Host: GitHub
• URL: https://github.com/status-im/specs
• Owner: status-im
• License: mit
• Created: 2019-03-25T04:31:29.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-12T02:44:13.000Z (7 months ago)
• Last Synced: 2024-06-23T18:33:33.740Z (6 months ago)
• Topics: website
• Language: HTML
• Homepage: https://specs.status.im/
• Size: 1.99 MB
• Stars: 14
• Watchers: 53
• Forks: 14
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
---

layout: default

permalink: /

nav_exclude: true

---

# Specifications for Status clients

![CI](https://github.com/status-im/specs/workflows/CI/badge.svg)

This repository contains a list of specifications for implementing Status and

its various capabilities.

## How to contribute

You can read about how to build this project [here](./DEVELOPMENT.md).

1. Create an issue for a new Status Improvement Proposal (SIP) or some bug that you'd like to address

2. Create a corresponding PR and ping some existing SIP editors for review

If you need help, ask in #protocol at [Status / Discord](https://discord.gg/3Exux7Y).

### Specification style guidelines

Become familiar with the [specification style guidelines](STYLE-GUIDELINE.md) to understand how you should write or amend specifications.

## Spec lifecycle

Every spec has its own lifecycle that shows its maturity. We indicate this in a similar fashion to [COSS Lifecycle](https://rfc.unprotocols.org/spec:2/COSS/):

![](assets/lifecycle.png)

At present (March 30, 2020) this means stable specs are what is in v1 of the Status App. Drafts and raw are work in progress specs.

## Status Improvement Proposals (SIPs)

The main specification for writing a Status client is [1/CLIENT](https://specs.status.im/spec/1).

For all full index of all specs, see [specs.status.im](https://specs.status.im/), especially stable specs.

## Protocol Research

These are protocols that are currently being researched. These are designed to

be useful outside of Status as well. To the extent that these protocols are used

within Status clients, they will show up as SIPs in the future.

To see more on this, please visit the current home: [vac protocol](https://specs.vac.dev).

# Continuous Integration

The site is built in [Our Jenkins CI](https://ci.status.im/job/website/job/specs.status.im/) based off of `master` branch.