Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.84 KB

contribution-guideline.md

File metadata and controls

34 lines (25 loc) · 1.84 KB

Contribution Guidelines

This page is WORK IN PROGRESS

You can contribute to mutable in several ways:

  • Contributing to the mutable codebase.
  • Writing plugins for mutable.
  • Writing documentation.
  • Participating in the design of mutable and writing design documents.

Any form of contribution is highly appreciated. For more ways to contribute, check out the Open Source Guides.

Below is a list of what you need to know before contributing to mutable:

  • Contributing to the mutable codebase ⌨️

    • Read our Coding Style Guide (coming soon)
    • Make sure your system provides the required preliminaries.
    • Become a member of our organization mutable-org.
    • Coordinate with us what you want to work on. We will connect you with people that can help you get started.
  • Writing plugins for mutable 🔌

    • Get a copy of mutable: either build it yourself (see preliminaries and setup) or download a pre-built binary with API headers (coming soon).
    • Have a look at our mutable API demo project (coming soon), where you find examples of how to write plugins for mutable.
  • Writing documentation 📝

    • Become a member of our organization mutable-org.
    • Coordinate with us what you want to work on. We can then connect you with people that can help you get started.
    • Receive our collective blessings 😇 and everlasting gratitude 🙏 for bringing order to chaos.
  • Participating in the design of mutable 🎨

    • Become a member of our organization mutable-org.
    • Join our weekly mutable team meeting (virtually or in person, if you live close by).