Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing: Getting Started

Thank you for your interest in contributing to Trial Submission Studio!

Ways to Contribute

Code Contributions

  • Bug fixes
  • New features
  • Performance improvements
  • Documentation updates

Non-Code Contributions

  • Bug reports
  • Feature requests
  • Documentation improvements
  • Testing and feedback
  • Helping other users

Before You Start

Prerequisites

  • Rust 1.92+ - Install via rustup
  • Git - For version control
  • Basic familiarity with Rust programming
  • (Optional) Understanding of CDISC SDTM standards

Read the Documentation

Familiarize yourself with:

Finding Issues to Work On

GitHub Issues

  1. Check GitHub Issues
  2. Look for labels:
    • good-first-issue - Great for newcomers
    • help-wanted - We’d love assistance
    • bug - Known issues to fix
    • enhancement - New features

Claiming an Issue

  1. Find an issue you want to work on
  2. Comment on the issue expressing interest
  3. Wait for maintainer feedback before starting
  4. Fork the repository
  5. Create a branch and start working

Contribution Workflow

Overview

1. Find Issue → 2. Comment → 3. Fork → 4. Branch → 5. Code → 6. Test → 7. PR

Detailed Steps

  1. Find an issue (or create one)
  2. Comment to claim it
  3. Fork the repository
  4. Clone your fork
  5. Create a branch (feature/my-feature or fix/my-fix)
  6. Make changes
  7. Test your changes
  8. Commit with conventional commit messages
  9. Push to your fork
  10. Create a Pull Request

Communication

Where to Discuss

  • GitHub Issues - Bug reports, feature requests
  • GitHub Discussions - Questions, ideas, general discussion
  • Pull Requests - Code review discussion

Guidelines

  • Be respectful and constructive
  • Assume good intentions
  • Welcome newcomers
  • Focus on the code, not the person

Code of Conduct

Please read and follow our Code of Conduct.

Key points:

  • Be respectful and inclusive
  • Welcome newcomers
  • Focus on constructive feedback
  • Assume good intentions

Getting Help

Stuck on Something?

  1. Check existing documentation
  2. Search GitHub Issues/Discussions
  3. Ask in GitHub Discussions
  4. Open an issue with your question

Review Process

After submitting a PR:

  1. Automated checks run (CI)
  2. Maintainer reviews code
  3. Address any feedback
  4. Maintainer merges when ready

Recognition

Contributors are recognized in:

  • GitHub contributor list
  • Release notes (for significant contributions)
  • THIRD_PARTY_LICENSES.md (if adding dependencies)

Next Steps