Update README.md

Author: niklub

README.md

@@ -1,6 +1,53 @@
 # label-studio-client-generator
 
-## Development
+## How to Contribute
+1. Create a new or modify [YAML OpenAPI spec](https://swagger.io/docs/specification/about/) for Label Studio endpoints.
+   For example, `./fern/openapi/resources/comments.yaml`:
+   ```yaml
+   paths:
+    /api/comments:
+      get: ...
+  	  post: ...
+   components:
+    schemas:
+      Comments: ...
+    requestBodies:
+      api_comments_create: ...
+   ```
+    - `paths` : contain API path
+    - `components` (optional): components to reuse in `responses`
+    - `requestBodies` (optional): request bodies specification to reuse in requests’ `requestBody`
+2. Add [`$ref` references](https://swagger.io/docs/specification/using-ref/) in `overrides.yaml`:
+   ```yaml
+   paths:
+    /api/comments/:
+      get:
+        $ref: "./resources/comments.yaml#/paths/~1api~1comments/get"
+        x-fern-sdk-group-name: comments
+        x-fern-sdk-method-name: list
+        x-fern-audiences:
+          - public
+      post:
+        $ref: "./resources/comments.yaml#/paths/~1api~1comments/post"
+        x-fern-sdk-group-name: comments
+        x-fern-sdk-method-name: create
+        x-fern-audiences:
+          - public
+   ```
+   this will define the public methods called `client.comments.list()` and `client.comments.create()`. Read more about [Fern's OpenAPI extensions](https://buildwithfern.com/learn/api-definition/openapi/extensions)
+3. Create a PR in `label-studio-client-generator` using [Follow-Merge workflow](https://www.notion.so/214a17976c254100a4c261ec800cf3e8?pvs=21). For example, push a branch called `fb-PRJ-123-update-comments-api` 
+4. Ensure PR is created in `label-studio-sdk` and Label Studio repo
+    
+    <aside>
+    ⚠️ Note: Follow-Merge automation is in progress. Until then, do it manually:
+    1. In `label-studio-client-generator` , perform Actions > Use workflow from [your PR branch] > Run workflow
+    2. Check the branches generated in `label-studio-sdk` repo and Label Studio repo.
+    
+    </aside>
+    
+5. Update added endpoints in Django code.
+6. Add integration tests with newly added functions in LS: `https://github.com/HumanSignal/label-studio/tree/develop/label_studio/tests/sdk`
+   
 
 ### Create openapi.yaml