Contributing

Mavkit is an open source software developed and maintained by a wide constellation of teams and contributors (collectively called platform developers) within a larger Mavryk ecosystem. Hence, it is open by nature and provides many interesting challenges for existing and new contributions.

Here you can find information about:

• the wide spectrum of possible contributions, and some corresponding workflows and guidelines

• the Mavkit Merge Team, which is the instance coordinating updates to the code base

• policies associated with the repository

etc.

• How to contribute to Mavkit
  • Introduction
  • Our git strategy
  • Workflow of an MR
  • Merge Queue Order
  • Preparing a Merge Request
  • Creating the Merge Request
  • Special case: MRs that introduce a new dependency
  • Protocol development MRs
  • Code Review
  • The Merge-Request Bot
• Mavkit Merge Team
  • Mavkit Merge Team Scope
  • Merge Coordinator
  • Getting into the Mavkit Merge Team
  • Helping the Mavkit Merge Team
• Documentation and coding guidelines
  • Documentation guidelines
  • Coding guidelines
• Scope of the Mavkit repository