Skip to content

status-im/feature-specs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This repository is new & currently very active WIP and in flux. Issues & existing specs are being sorted out.

npm install
hugo server

Feature specs should describe features & their functional requirements from a user's perspective. For implementation specs please refer to https://specs.status.im/

Feature Spec Format

1. Motivation

  • Short description of what the feature is about and what it intends to achieve.

2. Definitions

  • Relevant definitions of some terms used in the feature spec.

3. Designs

  • Links to figma designs

4. Use cases

5. Functional requirements

  • See RFC 2119
  • Specifications SHOULD use formal technical language (different from academic language).
  • Where appropriate, language SHOULD NOT use personal pronouns.
  • Avoid using the passive voice when being specific.
  • In places where the passive voice is appropriate but makes the subject ambiguous, append the passive voice with “by subject”. Alternatively restructure the sentence to be in the active voice adding the sentence subject.

6. Notes

  • Additional notes that might be relevant
  • Anything that should be noted/one should be aware of (security, possible needed API changes etc)

About

repo for feature specs & feature requests

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published