status-im
/
specs
mirror of https://github.com/status-im/specs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Specifications for Status clients. https://specs.status.im/
378 Commits 46 Branches 0 Tags 4 MiB
HTML 77%
JavaScript 20.9%
Ruby 2.1%
Go to file
Dean Eigenmann 7355f4cff0
text-lint (#131) 		2020-05-25 14:18:39 +02:00
.github/workflows spellcheck (#119) 2020-05-19 18:40:48 +02:00
assets Update spec lifecycle 2020-03-24 14:11:07 +08:00
docs text-lint (#131) 2020-05-25 14:18:39 +02:00
.remarkrc adds check, fixes links (#124) 2020-05-21 11:44:13 +02:00
.textlintrc text-lint (#131) 2020-05-25 14:18:39 +02:00
CNAME add CNAME for GH pages 2020-03-23 10:58:39 +01:00
README.md Update README.md (#121) 2020-05-21 12:17:29 +08:00
_config.yml Update _config.yml 2020-04-02 12:17:00 +02:00
default.html explicit layouts 2020-03-30 13:34:21 +08:00
home.html explicit layouts 2020-03-30 13:34:21 +08:00
package-lock.json text-lint (#131) 2020-05-25 14:18:39 +02:00
package.json text-lint (#131) 2020-05-25 14:18:39 +02:00
post.html explicit layouts 2020-03-30 13:34:21 +08:00
spellcheck.yaml spellcheck (#119) 2020-05-19 18:40:48 +02:00
wordlist.txt Update/waku replace (#114) 2020-05-22 15:05:21 +01:00

README.md

layout permalink nav_exclude
default / true

Specifications for Status clients

CI

This repository contains a list of specifications for implementing Status and its various capabilities.

How to contribute

  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.

Spellcheck

To run the spellchecker locally, you must install pyspelling.

It can then be run with the following command:

pyspelling -c spellcheck.yml

Words that should be ignored or are unrecognized must be added to the wordlist.

Markdown Verification

We use remark to verify our markdown. You can easily run this tool simply by using our npm package:

npm install
npm run lint

Spec lifecycle

Every spec has its own lifecycle that shows its maturity. We indicate this in a similar fashion to COSS Lifecycle:

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.

For all full index of all specs, see 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.