Skip to content

Add contributor infrastructure: sponsors, templates, branch protection docs#3

Draft
nexageapps with Copilot wants to merge 4 commits into
mainfrom
copilot/enhance-contributing-sponsors-branch-protection
Draft

Add contributor infrastructure: sponsors, templates, branch protection docs#3
nexageapps with Copilot wants to merge 4 commits into
mainfrom
copilot/enhance-contributing-sponsors-branch-protection

Conversation

Copilot AI commented Nov 22, 2025

Copy link
Copy Markdown
Contributor

Adds GitHub community health files and governance documentation to prepare repository for external contributions.

Changes

Commit 1: Sponsor configuration and README updates

  • .github/FUNDING.yml - GitHub Sponsors config for nexageapps
  • README.md - Added sponsor/contributor badges, links to contribution docs

Commit 2: Contribution workflow

  • CONTRIBUTING.md - Code style (PEP 8, Black), branch naming conventions, PR workflow, test execution, review process, security disclosure
  • .github/PULL_REQUEST_TEMPLATE.md - Standardized PR checklist
  • .github/ISSUE_TEMPLATE/{bug_report,feature_request}.md - Structured issue intake

Commit 3: Governance and changelog

  • FEATURE_UPDATES.md - Changelog template with Unreleased section
  • docs/BRANCH_PROTECTION.md - Branch protection settings for main (UI steps, REST API examples, automation options with PAT tradeoff analysis)
  • CODE_OF_CONDUCT.md - Contributor Covenant v2.1

Maintainer Actions Required

  1. Enable GitHub Sponsors (if desired) in profile settings
  2. Apply branch protection to main per docs/BRANCH_PROTECTION.md:
    • Require 1 PR approval
    • Require status checks (add after CI setup)
    • Dismiss stale reviews
    • Require conversation resolution
    • Block force pushes and deletions
  3. Add status checks once CI workflows are configured

Optional: Automate branch protection via GitHub Actions (see docs/BRANCH_PROTECTION.md for workflow template and security considerations).

Original prompt

Create a new branch 'enhance/contributing-sponsors-branch-protection' and open a pull request against 'main' that implements the following changes grouped into three commits.

Commit 1 (chore: add sponsor config and README contributor/sponsor badges):

  • Add file .github/FUNDING.yml with contents:
github: ["nexageapps"]
  • Update README.md by inserting near the top (without deleting existing content) sponsor badges and a short contributor/sponsor snippet linking to CONTRIBUTING.md and FEATURE_UPDATES.md. The snippet should mention branch protection and link to docs/BRANCH_PROTECTION.md.

Commit 2 (docs: add CONTRIBUTING, PR template and issue templates):

  • Add CONTRIBUTING.md at repo root with sections: code style & formatting, branch naming & PR workflow, running tests locally, submitting a PR checklist, review & merge process, branch protection & exceptions, security disclosure guidance. Use the content prepared in earlier conversation.
  • Add .github/PULL_REQUEST_TEMPLATE.md with a PR template including summary, checklist (linking to CONTRIBUTING.md and FEATURE_UPDATES.md), testing instructions, related issues, and notes for maintainers.
  • Add .github/ISSUE_TEMPLATE/bug_report.md and .github/ISSUE_TEMPLATE/feature_request.md with the prepared templates.

Commit 3 (docs: add FEATURE_UPDATES, branch protection guide and code of conduct):

  • Add FEATURE_UPDATES.md (changelog) with an Unreleased section and example entries.
  • Add docs/BRANCH_PROTECTION.md describing recommended branch protection settings for 'main', UI steps to enable them, REST API example, automation notes and exception process.
  • Add CODE_OF_CONDUCT.md with Contributor Covenant v2.1 short form and link to full text.

Additional requirements:

  • Preserve existing README content; append or insert additions near the top only.
  • Ensure file paths and names are correct (.github/, docs/).
  • Create clear commit messages as specified for each commit.
  • Open the pull request with this title and body:
    Title: Enhance contributor experience: sponsors, contribution guides, branch protection docs, and changelog
    Body: This PR makes the repository more welcoming to contributors and prepares it for repository governance and sponsorship.

Changes included:

  • Added .github/FUNDING.yml to enable the GitHub Sponsors button for nexageapps.
  • Updated README.md: sponsor badge + contribution/feature-updates pointers (preserves existing content).
  • Added CONTRIBUTING.md with coding standards, branch rules, local test instructions, and PR checklist.
  • Added .github/PULL_REQUEST_TEMPLATE.md to standardize PR submissions.
  • Added issue templates: bug_report.md, feature_request.md.
  • Added FEATURE_UPDATES.md (changelog) with an Unreleased section; please add changelog entries to Unreleased for future PRs.
  • Added docs/BRANCH_PROTECTION.md with step-by-step instructions and recommended settings for protecting main.
  • Added CODE_OF_CONDUCT.md (Contributor Covenant short form).

Commit structure: three commits as described above.

PR body should include next steps for maintainers: enabling GitHub Sponsors if needed, applying branch protection per docs/BRANCH_PROTECTION.md, adding required status checks after CI runs, and optional automation recommendations (GitHub Actions for changelog/release automation and a maintenance workflow to apply branch protection via REST API using org-maintained token or GitHub App; warn about PAT storage tradeoffs).

If any target files already exist, update them to include the new sponsor buttons and contribution flow without deleting existing useful content.

If branch protection cannot be applied automatically, include exact UI steps for maintainers in the PR body.

Make the PR actionable and ready for maintainers to review and merge. Please proceed to create the branch, commit the changes in three commits, push, and open the PR. Use the branch name 'enhance/contributing-sponsors-branch-protection'.

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

Create a new branch 'enhance/contributing-sponsors-branch-protection' and open a pull request against 'main' that implements the following changes grouped into three commits.

Commit 1 (chore: add sponsor config and README contributor/sponsor badges):

  • Add file .github/FUNDING.yml with contents:
github: ["nexageapps"]
  • Update README.md by inserting near the top (without deleting existing content) sponsor badges and a short contributor/sponsor snippet linking to CONTRIBUTING.md and FEATURE_UPDATES.md. The snippet should mention branch protection and link to docs/BRANCH_PROTECTION.md.

Commit 2 (docs: add CONTRIBUTING, PR template and issue templates):

  • Add CONTRIBUTING.md at repo root with sections: code style & formatting, branch naming & PR workflow, running tests locally, submitting a PR checklist, review & merge process, branch protection & exceptions, security disclosure guidance. Use the content prepared in earlier conversation.
  • Add .github/PULL_REQUEST_TEMPLATE.md with a PR template including summary, checklist (linking to CONTRIBUTING.md and FEATURE_UPDATES.md), testing instructions, related issues, and notes for maintainers.
  • Add .github/ISSUE_TEMPLATE/bug_report.md and .github/ISSUE_TEMPLATE/feature_request.md with the prepared templates.

Commit 3 (docs: add FEATURE_UPDATES, branch protection guide and code of conduct):

  • Add FEATURE_UPDATES.md (changelog) with an Unreleased section and example entries.
  • Add docs/BRANCH_PROTECTION.md describing recommended branch protection settings for 'main', UI steps to enable them, REST API example, automation notes and exception process.
  • Add CODE_OF_CONDUCT.md with Contributor Covenant v2.1 short form and link to full text.

Additional requirements:

  • Preserve existing README content; append or insert additions near the top only.
  • Ensure file paths and names are correct (.github/, docs/).
  • Create clear commit messages as specified for each commit.
  • Open the pull request with this title and body:
    Title: Enhance contributor experience: sponsors, contribution guides, branch protection docs, and changelog
    Body: This PR makes the repository more welcoming to contributors and prepares it for repository governance and sponsorship.

Changes included:

  • Added .github/FUNDING.yml to enable the GitHub Sponsors button for nexageapps.
  • Updated README.md: sponsor badge + contribution/feature-updates pointers (preserves existing content).
  • Added CONTRIBUTING.md with coding standards, branch rules, local test instructions, and PR checklist.
  • Added .github/PULL_REQUEST_TEMPLATE.md to standardize PR submissions.
  • Added issue templates: bug_report.md, feature_request.md.
  • Added FEATURE_UPDATES.md (changelog) with an Unreleased section; please add changelog entries to Unreleased for future PRs.
  • Added docs/BRANCH_PROTECTION.md with step-by-step instructions and recommended settings for protecting main.
  • Added CODE_OF_CONDUCT.md (Contributor Covenant short form).

Commit structure: three commits as described above.

PR body should include next steps for maintainers: enabling GitHub Sponsors if needed, applying branch protection per docs/BRANCH_PROTECTION.md, adding required status checks after CI runs, and optional automation recommendations (GitHub Actions for changelog/release automation and a maintenance workflow to apply branch protection via REST API using org-maintained token or GitHub App; warn about PAT storage tradeoffs).

If any target files already exist, update them to include the new sponsor buttons and contribution flow without deleting existing useful content.

If branch protection cannot be applied automatically, include exact UI steps for maintainers in the PR body.

Make the PR actionable and ready for maintainers to review and merge. Please proceed to create the branch, commit the changes in three commits, push, and open the PR. Use the branch name 'enhance/contributing-sponsors-branch-protection'.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Add contributing guidelines and sponsor badges Add contributor infrastructure: sponsors, templates, branch protection docs Nov 22, 2025
Copilot AI requested a review from nexageapps November 22, 2025 08:26
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