playbooks

home / skills / wdm0006 / python-skills / community

community skill

/skills/community

This skill helps you establish and govern a Python library community by creating CONTRIBUTING.md, CODE_OF_CONDUCT.md, templates, and automation.

npx playbooks add skill wdm0006/python-skills --skill community

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.7 KB
---
name: building-python-communities
description: Builds and manages open source Python library communities including CONTRIBUTING.md, CODE_OF_CONDUCT.md, issue/PR templates, contributor recognition, and GitHub automation. Use when setting up community infrastructure, improving contributor experience, or managing project governance.
---

# Python Library Community Management

## Essential Files

### CONTRIBUTING.md

```markdown
# Contributing

## Development Setup

git clone https://github.com/user/package.git
cd package
pip install -e ".[dev]"
pre-commit install
pytest

## Making Changes

1. Create a branch: `git checkout -b feature/name`
2. Make changes, add tests
3. Run: `make test && make lint`
4. Commit and open a PR

## Commit Messages

- `Add:` new feature
- `Fix:` bug fix
- `Update:` enhancement
- `Docs:` documentation
```

### CODE_OF_CONDUCT.md

Use [Contributor Covenant](https://www.contributor-covenant.org/) - the standard for open source.

## Issue Templates

**.github/ISSUE_TEMPLATE/bug_report.md:**
```markdown
---
name: Bug Report
labels: 'bug'
---
## Description
## To Reproduce
## Expected vs Actual Behavior
## Environment (OS, Python version, package version)
## Minimal Reproducible Example
```

**.github/ISSUE_TEMPLATE/feature_request.md:**
```markdown
---
name: Feature Request
labels: 'enhancement'
---
## Problem Statement
## Proposed Solution
## Example Usage
```

## PR Template

**.github/PULL_REQUEST_TEMPLATE.md:**
```markdown
## Description
## Related Issue (Fixes #)
## Checklist
- [ ] Tests added
- [ ] Documentation updated
- [ ] CHANGELOG entry added
```

## GitHub Actions Automation

```yaml
# .github/workflows/welcome.yml
on:
  pull_request_target:
    types: [opened]
jobs:
  welcome:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/first-interaction@v1
        with:
          pr-message: "Thanks for your first PR! 🎉"
```

## Labels

- `good first issue` - Newcomer-friendly
- `help wanted` - Extra attention needed
- `bug`, `enhancement`, `documentation`

For detailed templates, see:
- **[TEMPLATES.md](TEMPLATES.md)** - Full issue/PR templates
- **[GOVERNANCE.md](GOVERNANCE.md)** - Project governance guide

## Checklist

```
Initial Setup:
- [ ] CONTRIBUTING.md
- [ ] CODE_OF_CONDUCT.md
- [ ] Issue templates
- [ ] PR template
- [ ] Labels defined

Ongoing:
- [ ] Respond to issues within 48h
- [ ] Review PRs within 1 week
- [ ] Maintain good first issues
- [ ] Recognize contributors
```

## Learn More

This skill is based on the [Maintenance](https://mcginniscommawill.com/guides/python-library-development/#maintenance-the-long-game) section of the [Guide to Developing High-Quality Python Libraries](https://mcginniscommawill.com/guides/python-library-development/) by [Will McGinnis](https://mcginniscommawill.com/).

Overview

This skill builds and manages open source Python library communities by providing ready-made CONTRIBUTING and CODE_OF_CONDUCT files, issue and PR templates, label conventions, and GitHub automation for first-time contributors. It streamlines contributor onboarding, enforces basic governance, and automates welcome flows so maintainers can focus on code and reviews. The setup targets predictable contributor experience and clear expectations.

How this skill works

The skill generates and installs standard community files (CONTRIBUTING.md, CODE_OF_CONDUCT.md), adds structured issue and pull request templates, and defines common labels for triage. It can scaffold GitHub Actions for automating first-interaction messages and other simple workflows. Maintainable checklists and governance guidance help projects keep response time goals and contributor recognition practices consistent.

When to use it

  • Initializing a new Python library to ensure clear contributor onboarding.
  • Improving an existing project that lacks contributor docs or templates.
  • Standardizing multiple repositories across an organization.
  • Automating initial contributor interactions and PR triage.
  • Establishing basic governance and contributor recognition processes.

Best practices

  • Include a Contributor Covenant CODE_OF_CONDUCT.md to set behavioral expectations.
  • Make CONTRIBUTING.md explicit: development setup, branch/commit guidance, test/lint steps.
  • Provide clear, minimal issue and PR templates to speed triage and reviews.
  • Use labels like 'good first issue' and 'help wanted' and keep them documented.
  • Automate friendly first-PR messages but avoid excessive bots on repeated contributors.

Example use cases

  • Scaffold CONTRIBUTING.md and ISSUE_TEMPLATE files when creating a new project repository.
  • Add a welcome GitHub Action to thank and guide first-time PR authors.
  • Audit an existing repo to add missing templates, labels, and a CODE_OF_CONDUCT.md.
  • Define response time goals (e.g., respond to issues within 48 hours) and add them to governance.
  • Set up a contributor recognition section to highlight top contributors in release notes.

FAQ

Do I have to use the Contributor Covenant?

No, but Contributor Covenant is a widely adopted, community-vetted standard that covers common conduct scenarios. You can adapt it to your project's needs.

Can the templates be customized per project?

Yes. Templates are meant to be concise starting points; tailor the reproduction steps, environment details, and checklists to your codebase and workflow.