From 54d9b1762974050c2be68298ad4871720109b601 Mon Sep 17 00:00:00 2001
From: Tanmay Rustagi <88379306+tanmay-db@users.noreply.github.com>
Date: Mon, 7 Oct 2024 16:49:59 +0200
Subject: [PATCH] [Doc] Update CONTRIBUTING guide for plugin framework
 resources (#4078)

## Changes
<!-- Summary of your changes that are easy to understand -->
Update the guide to give detailed information on how to navigate and get
started with adding / migrating resources to plugin framework.

## Tests
<!--
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->
NA
- [ ] `make test` run locally
- [ ] relevant change in `docs/` folder
- [ ] covered with integration tests in `internal/acceptance`
- [ ] relevant acceptance tests are passing
- [ ] using Go SDK
---
 CONTRIBUTING.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4062159c53..ab38782660 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -118,6 +118,22 @@ We are migrating the resource from SDKv2 to Plugin Framework provider and hence
 - `pluginfw`: Contains the changes specific to Plugin Framework. This package shouldn't depend on sdkv2 or common.
 - `sdkv2`: Contains the changes specific to SDKv2. This package shouldn't depend on pluginfw or common.
 
+### Adding a new resource
+1. Check if the directory for this particular resource exists under `internal/providers/pluginfw/resources`, if not create the directory eg: `cluster`, `volume` etc... Please note: Resources and Data sources are organized under the same package for that service.
+2. Create a file with resource_resource-name.go and write the CRUD methods, schema for that resource. For reference, please take a look at existing resources eg: `resource_quality_monitor.go`
+3. Create a file with `resource_resource-name_acc_test.go` and add integration tests here.
+4. Create a file with `resource_resource-name_test.go` and add unit tests here. Note: Please make sure to abstract specific method of the resource so they are unit test friendly and not testing internal part of terraform plugin framework library. You can compare the diagnostics, for example: please take a look at: `data_cluster_test.go` 
+5. Add the resource under `internal/providers/pluginfw/pluginfw.go` in `Resources()` method. Please update the list so that it stays in alphabetically sorted order.
+6. Create a PR and send it for review. 
+
+### Adding a new data source
+1. Check if the directory for this particular datasource exists under `internal/providers/pluginfw/resources`, if not create the directory eg: `cluster`, `volume` etc... Please note: Resources and Data sources are organized under the same package for that service.
+2. Create a file with `data_resource-name.go` and write the CRUD methods, schema for that data source. For reference, please take a look at existing data sources eg: `data_cluster.go`
+3. Create a file with `data_resource-name_acc_test.go` and add integration tests here.
+4. Create a file with `data_resource-name_test.go` and add unit tests here. Note: Please make sure to abstract specific method of the resource so they are unit test friendly and not testing internal part of terraform plugin framework library. You can compare the diagnostics, for example: please take a look at: `data_cluster_test.go` 
+5. Add the resource under `internal/providers/pluginfw/pluginfw.go` in `DataSources()` method. Please update the list so that it stays in alphabetically sorted order.
+6. Create a PR and send it for review. 
+
 ### Migrating resource to plugin framework
 Ideally there shouldn't be any behaviour change when migrating a resource or data source to either Go SDk or Plugin Framework.
 - Please make sure there are no breaking differences due to changes in schema by running: `make diff-schema`.