Merge pull request #2 from helius-labs/dev

[Merge] Dev -> Main

.github/workflows/rust.yml

@@ -13,16 +13,54 @@ jobs:
   build:
 
     runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pull-requests: write
 
     steps:
     - uses: actions/checkout@v3
+      with:
+        fetch-depth: '0'
+
+    - name: Cache cargo registry
+      uses: actions/cache@v3
+      with:
+        path: ~/.cargo/registry
+        key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+
+    - name: Cache cargo index
+      uses: actions/cache@v3
+      with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
+
+    - name: Cache target directory
+      uses: actions/cache@v3
+      with:
+          path: target
+          key: ${{ runner.os }}-target-${{ hashFiles('**/Cargo.lock') }}
+
     - name: Set up Rust
       uses: actions-rs/toolchain@v1
       with:
         toolchain: stable
         profile: minimal
         override: true
+        components: clippy
+
+    - name: Install Protobuf Compiler
+      run: sudo apt-get update && sudo apt-get install -y protobuf-compiler
+
+    - name: Check formatting
+      run: cargo fmt --all -- --check
 
+    - name: rust-clippy-check
+      uses: giraffate/clippy-action@v1
+      with:
+          reporter: 'github-pr-review'
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
     - name: Build
       run: cargo build --verbose
 

.gitignore

@@ -1 +1,2 @@
 /target
+/src/main.rs

CONTRIBUTIONS.md

@@ -0,0 +1,37 @@
+# Contribution Guide
+Welcome to the Helius Rust SDK! We value your contributions and want to make it as easy as possible for you to contribute. Here's how you can help make the SDK better
+
+## Style Guide
+To maintain high standards of quality and readability, code should adhere to the following principles:
+- **Filenames**: Use underscores instead of dashes in filenames
+- **Main Entry Point**: Avoid naming files as `main.rs`. Use descriptive names that reflect their functionality
+- **Testing**: Add tests for any new features or functionality added
+- **Formatting**: Follow Rust conventions. Be consistent with the existing codebase. When in doubt, run `cargo fmt`
+- **Documentation**: Keep the documentation up to date. If you introduce new features or changes that affect how users interact with the SDK, update the documentation accordingly
+
+## Pull Requests
+Pull Requests are the best way to propose changes to the SDK. We actively welcome any and all pull requests! To do so,
+- Fork the repo and create your branch from `dev`
+- Add tests if you've introduced new functionality that should be tested
+- Update the relevant documentation if new functionality is introduced, or current functionality is altered
+- Ensure the test suite passes (`cargo test`)
+- Make the pull request!
+
+### Good Pull Request Titles
+- fix(enhanced_transactions): Issue with URL Format
+- feat(zk_api): Add Get Private Balance 
+- docs(webhooks): Add New Section on Deleting Webhooks
+
+### Bad Pull Request Titles
+- fix #76129
+- update docs
+- fix bugs
+
+### Related Issues
+If there is a related issue, please reference it in the pull request's text.
+
+## License
+By contributing, you agree that your contributions will be licensed under its MIT License. Thus, when you submit code changes, your submissions are understood to be under the [following license](https://github.com/helius-labs/helius-rust-sdk/blob/dev/LICENSE)
+
+## Thank You!
+We deeply appreciate your effort in improving the Helius Rust SDK. Your contributions help make the SDK a valuable tool for everyone