Skip to content

docs: add developer onboarding guide#635

Open
devAgatha wants to merge 1 commit into
Vera3289:mainfrom
devAgatha:feature/onboarding-guide-521
Open

docs: add developer onboarding guide#635
devAgatha wants to merge 1 commit into
Vera3289:mainfrom
devAgatha:feature/onboarding-guide-521

Conversation

@devAgatha

Copy link
Copy Markdown
Contributor

Summary

Adds a comprehensive developer onboarding guide to help new contributors get up to speed quickly, resolving #521.

Changes

  • docs/onboarding.md covering all acceptance criteria:
    • Architecture overview with data flow diagram and state machine
    • Code structure walkthrough with suggested reading order
    • Development environment setup (Rust, Stellar CLI, Docker)
    • Testing strategy with test anatomy examples and snapshot update instructions
    • Code style guide (naming conventions, error handling, commit messages)
    • Contributing guidelines
    • Pull request process with branch naming and review flow

Acceptance Criteria

  • Code structure overview
  • Architecture explanation
  • Development environment setup
  • Testing strategy and execution
  • Contributing guidelines
  • Code style guide
  • Pull request process

Closes #521

Comprehensive guide covering:
- Architecture overview with data flow and state machine diagrams
- Code structure walkthrough with reading order for new contributors
- Development environment setup (Rust, Stellar CLI, Docker)
- Testing strategy with examples and snapshot test instructions
- Code style guide (naming, error handling, commit conventions)
- Contributing guidelines
- Pull request process and branch naming conventions

Closes Vera3289#521
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write Developer Onboarding Guide

1 participant