Skip to content

Add contributing guides for maintainers#561

Open
andrewiggins wants to merge 1 commit intomainfrom
add-contributing-guides
Open

Add contributing guides for maintainers#561
andrewiggins wants to merge 1 commit intomainfrom
add-contributing-guides

Conversation

@andrewiggins
Copy link
Copy Markdown
Contributor

Add CONTRIBUTING.md files at the repo root and in each package to document the development workflow, release process, and automation for Shopify engineers maintaining this monorepo.

Root guide covers:

  • Getting started and local development setup
  • How Changesets manages versioning and changelogs
  • The two-step automated release flow (Version Packages PR → npm publish)

Package guides cover:

  • app-bridge-types: CDN-based build process, automated daily type update workflow, and manual release steps

@andrewiggins andrewiggins requested a review from a team April 2, 2026 23:22
@andrewiggins andrewiggins added the 🤖Skip Changelog Don't require a changelog for this PR label Apr 2, 2026
Add CONTRIBUTING.md files at the repo root and in each package to
document the development workflow, release process, and automation
for Shopify engineers maintaining this monorepo.

Root guide covers:
- Getting started and local development setup
- How Changesets manages versioning and changelogs
- The two-step automated release flow (Version Packages PR → npm publish)
- Overview of all CI/automation workflows

Package guides cover:
- app-bridge-types: CDN-based build process, automated daily type
  update workflow, and manual release steps
- app-bridge-react: Vite build setup, testing, and dependency
  relationship with app-bridge-types
@andrewiggins andrewiggins force-pushed the add-contributing-guides branch from c7e8a53 to 7a0e71c Compare April 2, 2026 23:44
### Summary

```
Feature PR (with changeset) ──merge──▶ main
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: We could also make this a mermaid diagram

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

Labels

🤖Skip Changelog Don't require a changelog for this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants