Skip to content

Pull Request Guidelines

Pull requests are the primary way to contribute code changes to Coho. Here are our guidelines for submitting PRs.

Creating a Pull Request

Try to follow the PR title and description format below.

PR Title Format

[TYPE] Brief description
Where TYPE is one of: NEW, FIX, DOCS, STYLE, REFACTOR, TEST

PR Description Template

## Description
Brief description of changes

## Related Issue
Fixes #(issue)

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code style update

## Testing
Describe testing done

## Screenshots
If applicable

## Checklist
- [ ] Code follows style guidelines
- [ ] Tests added/updated
- [ ] Documentation updated
- [ ] All tests passing

Submit your PR and wait for it to be reviewed.

Note: To submit a PR:

  1. Fork and branch: 

    git checkout -b feature/your-feature-name  # Use descriptive branch names

  2. Stage changes and commit: 

    git add .
git commit -m "[TYPE] Brief description"  # Be clear and concise

  3. Push and set upstream: 

    git push -u origin feature/your-feature-name  # -u links local and remote branches

  4. Open PR on Coho repository

  5. Add title, description, and related issues

  6. (optional) Clean up branches after merge: 

    # Delete local branch
git branch -d feature/your-feature-name

# Delete remote branch
git push origin --delete feature/your-feature-name

# Clean up stale remote references
git fetch --prune

Review Process

We (plan to) use GitHub Actions to run tests and linting. We also have a code of conduct that contributors must adhere to.