Skip to main content

Get started with contributing

Welcome

So you might be interested in contributing to Otomi, awesome! This guide will help you understand the overall organization of the project, and direct you to the best places to get started contributing. You'll be able to pick up issues, write code to fix them, and get your work reviewed and merged. All feedback is welcome!

This document is the single source of truth for how to contribute to the following code bases:

  • otomi-core: The heart of Otomi, a monorepo containing all the apps and configurations
  • otomi-tasks: The tasks used by core to massage apps to adhere to the configurations
  • otomi-clients: The openapi generator for the clients used by the tasks

Prerequisites

Before submitting code to Otomi, you should first complete the following prerequisites. Completing these steps will make your first contribution easier:

Code of Conduct

Please make sure to read and observe the Code of Conduct and Community Values

Developer guide

Effective development starts with an understanding the code structure and the relationship between different components of the system. Read the Code development guide to learn how to develop on Otomi.

Setting up your development environment

It is not required to set up a developer environment in order to contribute to Otomi, but if you do plan to contribute code changes, follow the instructions in the Developer Docs on how to Set up your development environment.

Community Expectations and Roles

Otomi is a community project. Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment.

Please read and review the Contribution Expectations for an understanding of code and review expectations.