How to contribute on SDK

All work on the SDK happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

The SDK follows semantic versioning. We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.
When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.
Every significant change is documented in the changelog file.

Make sure to fork the repository before contributing and create the new branch using develop as the base branch.
Submit all changes directly to the develop branch. We use separate branches for development or for upcoming releases. And then after the bug/feature is working we release in main branch.
Code that lands in develop must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of develop at any time.

Do not open up a GitHub issue if the bug is a security vulnerability, and instead refer our security policy.
Ensure the bug was not already reported by searching on GitHub under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample demonstrating the expected behavior that is not occurring.
Once the issue is created you can follow the contributing steps below to start contributing

If you intend to change/add a new feature to the sdk please discuss with us first on Discord before creating a new issue. This lets us reach an agreement on your proposal before you put significant effort into it.
Do not open an issue on GitHub until you have collected positive feedback about the feature from us.
We will reject issues which are not discussed with us regarding feature development.
Once the issue is created you can follow the contributing steps below to start contributing.

You have Node.js installed at LTS with version 18+ and using pnpm as package manager.
You have knowldge of git.
Read the code base overview to have a short introduction about how we manage/write code.

After cloning the repo
Install dependencies using pnpm
```
pnpm i
```
Create the sdk using our custom script(it should give .gatewaySdk folder with sdk in it)
```
pnpm generate:sdk
```
Run test command to test sdk using jest
```
pnpm test
```

We recommend to keep test coverage above 90% this way we make sure that the feature/bug you add don't reduce the test coverage. Also make sure that there are no linting errors as we use prettier and eslint to maintain proper code structure.

Thanks!

@Gateway-DAO Team

Provide feedback