Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (19 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

23 lines (19 loc) · 1.5 KB

Contributing

Install

git clone git@github.com:criteo/addressable-network-proposals.git
cd addressable-network-proposals
git submodule init # This step will soon be removed

Add or update mvp-spec

  • All main documents are located in /mvp-spec and use Markdown format (*.md)
    • the content of these documents can be updated by contributors, except the parts surrounded by <!--partial-begin ..--> and <!--partial-end-->: these sections should not be modified.
  • These special sections in Markdown documents are used to automatically "inject" content that needs to be repeated in different documents. We call these "partials".
    • Partials are stored in /mvp-spec/partials and can be modified
    • Mermaid diagrams (*.mmd) are also stored in this partials directory and can be modified
    • For details about the usage of partials, see the README
    • Some "partials" are generated by script. For instructions on how to update these examples, check the implementation project.
  • The model of data and messages is defined in /mvp-spec/json-schemas
  • The associated documentation is generated in /mvp-spec/model
    • For details about the generation of model documentation, see the README