Skip to content
Docs

Contributing to Spry

Thank you for your interest in contributing to Spry! We welcome contributions in all forms - whether it’s reporting bugs, suggesting features, improving documentation, or submitting code.

Ways to Contribute

Section titled “Ways to Contribute”

There are many ways to contribute to Spry:

  • Report Bugs - Help us identify and fix issues
  • Suggest Features - Share ideas for new capabilities
  • Improve Documentation - Help make our docs clearer and more comprehensive
  • Write Code - Submit pull requests to fix bugs or add features
  • Help Others - Answer questions in discussions and issues
  • Share Examples - Show the community what you’ve built with Spry

Getting Started

Section titled “Getting Started”

Prerequisites

Section titled “Prerequisites”

Before contributing to Spry, ensure you have:

Setting Up Your Development Environment

Section titled “Setting Up Your Development Environment”

  1. Fork the repository

    Visit github.com/programmablemd/spry and click the “Fork” button.

  2. Clone your fork

    Terminal window
    git clone https://github.com/YOUR_USERNAME/spry.git
    cd spry

  3. Add upstream remote

    Terminal window
    git remote add upstream https://github.com/programmablemd/assurance-prime.git

  4. Install dependencies

    Terminal window
    deno cache --reload lib/mod.ts

  5. Verify your setup

    Terminal window
    deno test

đŸ’» Ready to Write Code?

Section titled â€œđŸ’» Ready to Write Code?”

If you plan to work on the Spry source code, you need specific technical setup details, commands, and knowledge of the project structure.

→ Continue to the Code Contributor Guide

Documentation

Section titled “Documentation”

Documentation Standards

Section titled “Documentation Standards”
  • Write clear, concise documentation
  • Include practical examples
  • Keep the audience in mind (beginners vs advanced users)
  • Update docs alongside code changes
  • Use proper Markdown formatting

Documentation Types

Section titled “Documentation Types”
  1. API Documentation - JSDoc comments in code
  2. User Guides - Step-by-step tutorials
  3. Reference - Comprehensive feature documentation
  4. Examples - Working Spryfile.md examples

Community Guidelines

Section titled “Community Guidelines”

Code of Conduct

Section titled “Code of Conduct”

We are committed to providing a welcoming and inclusive environment. Please:

  • Be respectful and considerate
  • Accept constructive criticism gracefully
  • Focus on what’s best for the community
  • Show empathy towards other community members

Communication

Section titled “Communication”
  • Use GitHub Issues for bug reports and feature requests
  • Use GitHub Discussions for questions and ideas
  • Join Discord for real-time chat
  • Be patient - maintainers are often volunteers

Review Process

Section titled “Review Process”
  1. Initial Review - Maintainers will review within 1-2 weeks
  2. Feedback - Address any requested changes
  3. Approval - Once approved, PR will be merged
  4. Release - Changes included in next release

Recognition

Section titled “Recognition”

Contributors are recognized in:

  • The CONTRIBUTORS.md file
  • Release notes for significant contributions
  • Project README for major features

Questions?

Section titled “Questions?”

If you have questions about contributing:

  1. Check the FAQ
  2. Ask in GitHub Discussions
  3. Reach out on Discord

Thank you for contributing to Spry! Your efforts help make executable Markdown accessible to everyone.