Skip to Content
ContributorsContributing Guide

Contributing to Astraio

Thank you for your interest in contributing to Astraio Client!

Prerequisites

  1. Rust — Install via rustup :
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  1. Git — For version control

Getting Started

1. Fork & Clone

git clone https://github.com/YOUR_USERNAME/astraio-client.git
cd astraio-client

2. Build

cargo build

3. Run

cargo run

Development Workflow

  1. Create a feature branch:
git checkout -b feature/my-feature
  1. Make your changes
  2. Test thoroughly
  3. Commit with clear messages
  4. Push and create a PR

Code Style

  • Follow Rust conventions (rustfmt and clippy)
  • Write meaningful variable/function names
  • Add comments for complex logic
  • Keep functions small and focused

Run Linting

cargo clippy

Format Code

cargo fmt

Commit Messages

Use conventional commits:

feat: add WebSocket support
fix: resolve timeout issue
docs: update README
refactor: simplify request handling

Pull Request Guidelines

  1. One feature per PR — Keep changes focused
  2. Write clear descriptions — Explain what and why
  3. Include screenshots — For UI changes
  4. Update documentation — If adding features
  5. Test on all platforms — macOS, Windows, Linux

Reporting Issues

  • Use GitHub Issues
  • Include steps to reproduce
  • Provide OS and version info
  • Attach screenshots if applicable

Questions?

Open a discussion on GitHub Discussions .

Last updated on
ArchitectureProject Structure