This issue was migrated from sonr-io/sonr2#239
Migration date: Fri Oct 3 03:17:00 PM EDT 2025

Requirements

• Must include comprehensive contributing documentation with clear guidelines for community contributions
• Must implement proper GNU General Public License v3.0 (GPL-3.0) licensing
• Must have comprehensive CI/CD pipeline with automated testing and quality checks
• Must establish GitHub Projects for tracking and managing community bounties
• Must implement systematic issue and PR labeling for better organization
• Must configure merge queue with automated build and release dry-runs
• Must include end-to-end test execution from test/ directory
• Must automate smart contract deployment and verification

Context

Affected Files

• CONTRIBUTING.md - New comprehensive contribution guidelines
• LICENSE - GPL-3.0 license file
• CODE_OF_CONDUCT.md - Community code of conduct
• SECURITY.md - Security policy and vulnerability reporting
• .github/workflows/ci.yml - Comprehensive CI pipeline
• .github/workflows/release.yml - Automated release workflow
• .github/workflows/merge-queue.yml - Merge queue validation
• .github/workflows/contracts.yml - Smart contract CI/CD workflow
• .github/workflows/e2e-tests.yml - End-to-end test workflow
• .github/ISSUE_TEMPLATE/bug_report.md - Bug report template
• .github/ISSUE_TEMPLATE/feature_request.md - Feature request template
• .github/ISSUE_TEMPLATE/config.yml - Issue template configuration
• .github/pull_request_template.md - PR template with checklist
• .github/labeler.yml - Automatic PR labeling configuration
• .github/CODEOWNERS - Code ownership definitions
• README.md - Updates for open-source community
• .github/FUNDING.yml - Sponsorship configuration
• test/e2e/tests/ - End-to-end test suites
• test/integration/ - Integration test suites
• contracts/wSNR/ - Wrapped SNR smart contract

Relevant Documentation

• GitHub Docs: Creating a default community health file
• GitHub Docs: About merge queues
• GitHub Docs: Managing labels
• GNU GPL v3.0 License
• GitHub Projects documentation
• Cosmos SDK Contributing Guidelines
• Foundry Documentation
• Interchaintest Documentation

Acceptance Criteria

• Contributing Documentation: Create CONTRIBUTING.md with sections for: development setup, code style guidelines, commit message format, testing requirements, PR process, and issue reporting
• GPL-3.0 License: Add LICENSE file with full GPL-3.0 text and update README with license badge
• CI Pipeline: Implement comprehensive GitHub Actions workflow that runs: Go tests (unit, integration, e2e), TypeScript/JavaScript tests, linting (golangci-lint, biome), build verification, and coverage reporting
• Merge Queue: Configure merge queue with automatic validation including: build verification, test execution, and release dry-run
• Issue Templates: Create standardized templates for bug reports, feature requests, and documentation improvements
• PR Template: Implement PR template with checklist for: tests, documentation, breaking changes, and changelog entry
• Labeling System: Define and document labels for: module areas (x/did, x/dwn, x/svc), types (bug, feature, documentation), priority levels, and effort estimates
• Auto-labeling: Configure GitHub labeler to automatically apply labels based on file paths modified
• GitHub Project: Create project board with columns for: Triage, Backlog, In Progress, Review, Done, and configure automation rules
• Community Bounties: Establish bounty program with clear guidelines, reward tiers, and payment process documentation
• Code of Conduct: Add CODE_OF_CONDUCT.md based on Contributor Covenant
• Security Policy: Create SECURITY.md with vulnerability disclosure process and security contact information
• Code Ownership: Define CODEOWNERS file mapping code areas to maintainers
• Funding Configuration: Set up FUNDING.yml for GitHub Sponsors or other funding platforms
• README Updates: Update README with badges for: build status, test coverage, license, contributors, and community links
• E2E Test Workflow: Create GitHub Actions workflow that runs end-to-end tests from test/e2e/tests/ including: basic chain tests, IBC tests, module tests (did, dwn, svc), WebAuthn integration tests, and DEX tests
• Integration Test Workflow: Add workflow for integration tests from test/integration/ including: DWN encryption tests, encryption security tests, UCAN workflow tests, and event integration tests
• Contract Deployment CI: Implement GitHub Actions workflow for contracts/wSNR/ that: runs Foundry tests, performs security analysis with Slither/Mythril, deploys to testnets on merge to main, verifies contracts on block explorers, and publishes deployment artifacts
• Contract Release Management: Set up automated contract versioning, deployment tracking, and upgrade verification for the wSNR token contract
• Test Matrix Configuration: Configure test matrix to run e2e tests against multiple chain configurations (localchain, testnet configurations) and Go versions
• Integration Tests Verification: Verify all CI workflows pass on test PRs before making repository public