Pull Request Workflow

How to submit changes to Spry.

Before You Start

1. Check existing issues - Your idea may already be discussed
2. Open an issue first - For significant changes, discuss before coding
3. Understand the codebase - Read relevant documentation

Workflow

# Fork on GitHub, then clone your fork
git clone https://github.com/YOUR_USERNAME/spry.git
cd spry

# Add upstream remote
git remote add upstream https://github.com/programmablemd/spry.git

# Sync with upstream
git fetch upstream
git checkout main
git merge upstream/main

# Create feature branch
git checkout -b feature/my-feature
# Or for fixes:
git checkout -b fix/issue-123

# Make your changes
# Write tests
# Update documentation if needed

# Format and lint
deno task fmt
deno task lint

# Run tests
deno task test

git add .
git commit -m "feat(axiom): add support for nested dependencies"

type(scope): subject

body (optional)

Fixes #123 (optional)

git push origin feature/my-feature

Pull Request Template

## Description

Brief description of the changes.

## Type of Change

- [ ] Bug fix
- [ ] New feature
- [ ] Documentation
- [ ] Refactoring
- [ ] Other (describe)

## How Has This Been Tested?

Describe testing approach.

## Checklist

- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have added tests that prove my fix/feature works
- [ ] New and existing tests pass locally
- [ ] I have updated relevant documentation

Review Process

What Reviewers Look For

Responding to Feedback

• Be responsive to comments
• Ask for clarification if needed
• Push fixes as new commits
• Don't rebase during review

After Approval

git checkout main
git fetch upstream
git merge upstream/main
git push origin main
git branch -d feature/my-feature

Types of Contributions

Tips for Success

Do ✅

• Keep PRs focused and small
• Write clear commit messages
• Respond to feedback promptly
• Test thoroughly
• Update docs

Don't ❌

• Mix multiple changes in one PR
• Force push during review
• Ignore CI failures
• Add unrelated changes

Getting Help

• Ask in the PR comments
• Reference documentation
• Check similar past PRs

CI Checks

PRs run automated checks:

1. Formatting - deno fmt --check
2. Linting - deno lint
3. Type Check - deno task check
4. Tests - deno task test

All checks must pass before merge.

After Merge

You'll be:

• Listed in contributors
• Credited in release notes (for features/fixes)