Iuri Matias be5fe20723 Merge pull request #43 from status-im/update_readme
update readme to clarify what feature specs are; add definitions section
2021-12-07 13:55:17 -05:00
2021-11-08 16:00:04 -05:00
2021-11-08 16:00:04 -05:00
2021-11-08 16:00:04 -05:00
2021-11-08 16:00:04 -05:00
2021-11-08 16:00:04 -05:00
2021-11-08 16:00:04 -05:00
2021-11-08 16:00:04 -05:00
2021-11-08 16:00:04 -05:00

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)
S
Description
repo for feature specs & feature requests
Readme
294 KiB
Languages
SCSS 47.1%
HTML 44.2%
JavaScript 8.7%