Skip to content

docs: add contributing guide and per-package release workflows#1

Merged
jieyao-MilestoneHub merged 1 commit into
mainfrom
docs/contributing-guide
Apr 10, 2026
Merged

docs: add contributing guide and per-package release workflows#1
jieyao-MilestoneHub merged 1 commit into
mainfrom
docs/contributing-guide

Conversation

@jieyao-MilestoneHub
Copy link
Copy Markdown
Contributor

What does this PR do?

Adds developer-facing documentation and fixes PyPI publishing setup.

Contributing guide — friendly onboarding for new contributors:

  • Getting started (fork → install → verify)
  • PR workflow (branch → test → submit)
  • Code guidelines (framework-first, no business logic, test boundaries)
  • 89 lines, written for first-time contributors

PR template — simplified to 3-item checklist

Release workflows — split single release.yml into 3 per-package workflows:

  • release-core.yml → publishes mcp-forge-core to PyPI
  • release-aws.yml → publishes mcp-forge-aws to PyPI
  • release-cli.yml → publishes mcp-forge-cli to PyPI

This fixes PyPI trusted publishing — each package requires a unique workflow file.

How to test

  • Review CONTRIBUTING.md for tone and completeness
  • Verify 3 release workflow files match PyPI trusted publisher config
  • PR template renders correctly on GitHub

- Rewrite CONTRIBUTING.md for new contributors (friendly tone, 89 lines)
- Simplify PR template to 3-item checklist
- Split release.yml into 3 per-package workflows (release-core.yml,
  release-aws.yml, release-cli.yml) for PyPI trusted publishing —
  each package needs a unique workflow file

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jieyao-MilestoneHub jieyao-MilestoneHub added the docs Documentation label Apr 10, 2026
@jieyao-MilestoneHub jieyao-MilestoneHub self-assigned this Apr 10, 2026
@jieyao-MilestoneHub jieyao-MilestoneHub merged commit 3c417ac into main Apr 10, 2026
7 checks passed
@jieyao-MilestoneHub jieyao-MilestoneHub deleted the docs/contributing-guide branch April 10, 2026 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant