Skip to content

Add contribution infrastructure, sponsor support, and governance documentation#2

Draft
nexageapps with Copilot wants to merge 4 commits into
mainfrom
copilot/add-sponsor-buttons-and-changelog
Draft

Add contribution infrastructure, sponsor support, and governance documentation#2
nexageapps with Copilot wants to merge 4 commits into
mainfrom
copilot/add-sponsor-buttons-and-changelog

Conversation

Copilot AI commented Nov 22, 2025

Copy link
Copy Markdown
Contributor

Adds community health files, contribution workflow, and GitHub Sponsors integration to prepare the repository for open-source collaboration.

Changes

Sponsor Integration

  • .github/FUNDING.yml - GitHub Sponsors configuration
  • README badges for GitHub Sponsors

Contribution Workflow

  • CONTRIBUTING.md - Code style (Black, flake8), branch naming conventions, PR/review process, testing guide
  • .github/PULL_REQUEST_TEMPLATE.md - Checklist for tests, docs, changelog
  • .github/ISSUE_TEMPLATE/{bug_report,feature_request}.md - Standardized issue intake

Governance & Documentation

  • CODE_OF_CONDUCT.md - Contributor Covenant v2.1
  • FEATURE_UPDATES.md - Changelog template with initial entries
  • docs/BRANCH_PROTECTION.md - Admin guide for enabling branch protection (manual + automation options)

README Updates

  • Added contributing section linking to workflow docs
  • Branch protection and PR flow explanation

Post-Merge Actions

  1. Enable GitHub Sponsors on account (if not already active)
  2. Configure branch protection on main:
    • Require 1 approval
    • Require status checks
    • Require linear history
    • See docs/BRANCH_PROTECTION.md for complete settings
  3. Consider adding CI/CD (linting, tests) in follow-up
Original prompt

Make the repository welcoming and safe for contributions and add sponsor buttons and a feature-updates changelog. Changes to include in a single pull request:

  1. Add .github/FUNDING.yml to enable GitHub sponsor button (points to the org/user 'nexageapps').

Contents:

github: ["nexageapps"]
  1. Update README.md: add sponsor badges at the top, add a short "How to contribute" snippet that links to CONTRIBUTING.md, add a "Feature updates" section that links to FEATURE_UPDATES.md, and add a short blurb about branch protection and contribution flow.

Suggested README changes (add near top):

  • Sponsor badges: GitHub Sponsors badge and a generic sponsor/shields badge that links to https://github.com/sponsors/nexageapps and to other options like Open Collective placeholder.
  • Contributing snippet linking to CONTRIBUTING.md
  • Feature updates linking to FEATURE_UPDATES.md
  1. Add CONTRIBUTING.md at the repo root with clear style guide and contribution workflow. Include sections:
  • Code style and formatting (prettier/black rules, linter commands)
  • Branch naming and PR workflow (branch names, annual PR template link)
  • How to run tests locally
  • How to submit a PR and checklist (using the PULL_REQUEST_TEMPLATE)
  • How maintainers will review and merge
  • How to request branch protection and who can change it (direct to docs/BRANCH_PROTECTION.md)
  1. Add .github/PULL_REQUEST_TEMPLATE.md with a checklist and template for PRs including testing, linked issues, and changelog entry.

  2. Add ISSUE templates in .github/ISSUE_TEMPLATE/bug_report.md and feature_request.md to standardize incoming issues.

  3. Add FEATURE_UPDATES.md (or CHANGELOG.md) to track feature updates. Provide an initial template with an Unreleased section and an entry example.

  4. Add docs/BRANCH_PROTECTION.md with explicit instructions for repository admins on how to enable branch protection for 'main' (recommended settings: require PR reviews, require status checks to pass, require signed commits optional, require linear history, restrict who can push) and an explanation of how contributors should open PRs and request exceptions.

  5. Add CODE_OF_CONDUCT.md (Contributor Covenant v2.1 short form) so contributors know expected behavior.

Files to create and their suggested content are listed above. Make the PR against the main branch in a new branch named 'enhance/contributing-sponsors-branch-protection'.

Please create clear commit messages and group changes logically (one commit for README and FUNDING.yml; one commit for contributing and templates; one commit for docs). Provide a descriptive PR body explaining what's included and instructions for maintainers on next steps (particularly: enabling GitHub Sponsors if not enabled; applying branch protection using the recommended settings in docs/BRANCH_PROTECTION.md).

Also include guidance in the PR body about optional automation: recommend adding a GitHub Action in a follow-up PR to automatically create releases from FEATURE_UPDATES.md or to sync a CHANGELOG, and recommend using a repository secret or admins to apply branch protection via GitHub settings or the REST API. If the repo admin wants, note that we can create an optional workflow to apply branch protection using a PAT secret (explain tradeoffs).

If any of these files already exist, update them to include the new sponsor buttons and contribution flow, but do not delete existing useful content. Preserve existing README content and append additions near the top.

Make sure the PR includes all new files and updates and that paths are correct (.github/, docs/).

If you cannot apply branch protection automatically, ensure the PR body includes exact steps (clicks and settings) for maintainers to enable them.


Files to add/update (summary):

  • .github/FUNDING.yml
  • README.md (updated)
  • CONTRIBUTING.md
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • FEATURE_UPDATES.md
  • docs/BRANCH_PROTECTION.md
  • CODE_OF_CONDUCT.md

Make the PR actionable and ready for maintainers to review and merge.

This pull request was created as a result of the following prompt from Copilot chat.

Make the repository welcoming and safe for contributions and add sponsor buttons and a feature-updates changelog. Changes to include in a single pull request:

  1. Add .github/FUNDING.yml to enable GitHub sponsor button (points to the org/user 'nexageapps').

Contents:

github: ["nexageapps"]
  1. Update README.md: add sponsor badges at the top, add a short "How to contribute" snippet that links to CONTRIBUTING.md, add a "Feature updates" section that links to FEATURE_UPDATES.md, and add a short blurb about branch protection and contribution flow.

Suggested README changes (add near top):

  • Sponsor badges: GitHub Sponsors badge and a generic sponsor/shields badge that links to https://github.com/sponsors/nexageapps and to other options like Open Collective placeholder.
  • Contributing snippet linking to CONTRIBUTING.md
  • Feature updates linking to FEATURE_UPDATES.md
  1. Add CONTRIBUTING.md at the repo root with clear style guide and contribution workflow. Include sections:
  • Code style and formatting (prettier/black rules, linter commands)
  • Branch naming and PR workflow (branch names, annual PR template link)
  • How to run tests locally
  • How to submit a PR and checklist (using the PULL_REQUEST_TEMPLATE)
  • How maintainers will review and merge
  • How to request branch protection and who can change it (direct to docs/BRANCH_PROTECTION.md)
  1. Add .github/PULL_REQUEST_TEMPLATE.md with a checklist and template for PRs including testing, linked issues, and changelog entry.

  2. Add ISSUE templates in .github/ISSUE_TEMPLATE/bug_report.md and feature_request.md to standardize incoming issues.

  3. Add FEATURE_UPDATES.md (or CHANGELOG.md) to track feature updates. Provide an initial template with an Unreleased section and an entry example.

  4. Add docs/BRANCH_PROTECTION.md with explicit instructions for repository admins on how to enable branch protection for 'main' (recommended settings: require PR reviews, require status checks to pass, require signed commits optional, require linear history, restrict who can push) and an explanation of how contributors should open PRs and request exceptions.

  5. Add CODE_OF_CONDUCT.md (Contributor Covenant v2.1 short form) so contributors know expected behavior.

Files to create and their suggested content are listed above. Make the PR against the main branch in a new branch named 'enhance/contributing-sponsors-branch-protection'.

Please create clear commit messages and group changes logically (one commit for README and FUNDING.yml; one commit for contributing and templates; one commit for docs). Provide a descriptive PR body explaining what's included and instructions for maintainers on next steps (particularly: enabling GitHub Sponsors if not enabled; applying branch protection using the recommended settings in docs/BRANCH_PROTECTION.md).

Also include guidance in the PR body about optional automation: recommend adding a GitHub Action in a follow-up PR to automatically create releases from FEATURE_UPDATES.md or to sync a CHANGELOG, and recommend using a repository secret or admins to apply branch protection via GitHub settings or the REST API. If the repo admin wants, note that we can create an optional workflow to apply branch protection using a PAT secret (explain tradeoffs).

If any of these files already exist, update them to include the new sponsor buttons and contribution flow, but do not delete existing useful content. Preserve existing README content and append additions near the top.

Make sure the PR includes all new files and updates and that paths are correct (.github/, docs/).

If you cannot apply branch protection automatically, ensure the PR body includes exact steps (clicks and settings) for maintainers to enable them.


Files to add/update (summary):

  • .github/FUNDING.yml
  • README.md (updated)
  • CONTRIBUTING.md
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • FEATURE_UPDATES.md
  • docs/BRANCH_PROTECTION.md
  • CODE_OF_CONDUCT.md

Make the PR actionable and ready for maintainers to review and merge.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 3 commits November 22, 2025 08:15
Co-authored-by: nexageapps <116626075+nexageapps@users.noreply.github.com>
…ive badge

Co-authored-by: nexageapps <116626075+nexageapps@users.noreply.github.com>
Co-authored-by: nexageapps <116626075+nexageapps@users.noreply.github.com>
Copilot AI changed the title [WIP] Add sponsor buttons and feature updates changelog Add contribution infrastructure, sponsor support, and governance documentation Nov 22, 2025
Copilot AI requested a review from nexageapps November 22, 2025 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants