Contributing
Getting Started: Dev Env setup
We've created a document explaining how to setup your dev environment. Read it here.
Understanding the Code base
Go through this document to understand the architecture & how the system is built -- Notion doc . Like to traverse code in your IDE? Try navigating from this file or this file
Good First Issues: Integrations
Integrations are typically a great first issue as we've solved for more than a dozen of them and adding a new one will get you familiar to the repo. There are 3 types of changes to be added in the repo for a new integration-
- Handle connection to the tool via PlayBooks
- Define and implement changes to execute commands / tasks and get results in relevant format on playbooks
- Define assets that can be used in tasks to help create the tasks for that tool (this helps in creating the dropdowns within tasks in PlayBooks)
You can follow the below PRs in same order to achieve the same. The below tickets are for Elastic Search integration:
- New connector PR: Adds Elastic Search connector source #280
- New Task Source PR: Adds the task #282
- Asset manager PR: Adds es asset manager #284
These PRs are a good starting point to plan your changes. Please note there might be some changes added to the repo since the time these PRs were created, so you might have to navigate those. Feel free to reach out on our slack community in the #contributing channel.
Updated 3 months ago