add contribution guidelines (#34)

* add contribution guidelines

* fix text

* update texts

* error on creating clusters on mainnet

* format fixes

* revert back to support mainnet

README.md

@@ -1,10 +1,40 @@
 ![Obol Logo](https://obol.tech/obolnetwork.png)
 
-
 <h1 align="center">Obol SDK</h1>
 
-This repo contains the Obol Software Development Kit, for creating Distributed Validators with the help of the [Obol API](https://docs.obol.tech/api). 
+This repo contains the Obol Software Development Kit, for creating Distributed Validators with the help of the [Obol API](https://docs.obol.tech/api).
 
 ## Getting Started
 
-Checkout our [docs](https://docs.obol.tech/docs/advanced/quickstart-sdk), [examples](https://github.com/ObolNetwork/obol-sdk-examples/), and SDK [reference](https://obolnetwork.github.io/obol-sdk). Further guides and walkthroughs coming soon. 
+Checkout our [docs](https://docs.obol.tech/docs/advanced/quickstart-sdk), [examples](https://github.com/ObolNetwork/obol-sdk-examples/), and SDK [reference](https://obolnetwork.github.io/obol-sdk). Further guides and walkthroughs coming soon.
+
+## Contributing
+
+Please review the following guidelines:
+
+- [How to Report Bugs](#how-to-report-bugs)
+- [How to Propose Changes](#how-to-propose-changes)
+- [Code Review Process](#code-review-process)
+
+### How to Report Bugs
+
+If you encounter a bug or unexpected behavior, please follow these steps to report it:
+
+1. Go to the "Issues" tab of this repository.
+2. Click on the "Get started" button in the Bug report section.
+3. Provide a clear title and description of the issue following the format provided.
+
+### How to Propose Changes
+
+If you'd like to propose improvements or new features, please follow these steps:
+
+1. Fork this repository.
+2. Create a new branch for your changes.
+3. Make your changes and commit them with clear messages.
+4. Open a pull request with a detailed description of the changes.
+
+### Code Review Process
+
+All contributions are reviewed before they are merged into the main branch. Please address any feedback provided during the review process.
+
+Thank you for contributing to Obol-SDK!

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obolnetwork/obol-sdk",
-  "version": "1.0.13",
+  "version": "1.0.12",
   "description": "A package for creating Distributed Validators using the Obol API.",
   "bugs": {
     "url": "https://github.com/obolnetwork/obol-sdk/issues"

src/constants.ts

@@ -115,6 +115,6 @@ export enum DefinitionFlow {
 }
 
 export const DEFAULT_BASE_URL = 'https://api.obol.tech'
-export const DEFAULT_CHAIN_ID = 1
+export const DEFAULT_CHAIN_ID = 17000
 
 export const ETHER_TO_GWEI = 10 ** 9

test/methods.test.ts

@@ -21,13 +21,13 @@ describe('Cluster Client', () => {
     mockSigner,
   )
 
-  test('throws invalid ChainId when it is equal to 1', async () => {
-    try {
-      new Client({ chainId: 1 }, mockSigner)
-    } catch (error: any) {
-      expect(error.message).toBe('Invalid ChainId')
-    }
-  })
+  // test('throws invalid ChainId when it is equal to 1', async () => {
+  //   try {
+  //     new Client({ chainId: 1 }, mockSigner)
+  //   } catch (error: any) {
+  //     expect(error.message).toBe('Obol-SDK is in Beta phase, mainnet is not yet supported')
+  //   }
+  // })
 
   test('createClusterDefinition should return config_hash', async () => {
     clientInstance['request'] = jest

test/sdk-package-test/yarn.lock

@@ -783,7 +783,7 @@
     rimraf "^3.0.2"
 
 "@obolnetwork/obol-sdk@file:../..":
-  version "1.0.13"
+  version "1.0.12"
   dependencies:
     "@chainsafe/bls" "6.0.3"
     "@chainsafe/blst" "^0.2.9"