subculture-collective/discord-spywatcher
1
0
Fork 0
Code Issues 2 Pull Requests 23 Actions Packages Projects Releases Wiki Activity

[WIP] Create contributing guidelines for open source contributors #170

Merged
Copilot merged 4 commits from copilot/add-contributing-guidelines into main 2025-11-04 15:38:59 -06:00
Conversation 2 Commits 4 Files Changed 33 +3288 -1769
Copilot commented 2025-11-03 20:57:50 -06:00 (Migrated from github.com)
Copy Link

Contributing Guidelines - Open Source Standards

Creating comprehensive contributing guidelines following open source best practices.

Plan:

  • Create comprehensive CODE_OF_CONDUCT.md based on Contributor Covenant
  • Enhance CONTRIBUTING.md with more details on contribution process
  • Create issue templates (.github/ISSUE_TEMPLATE/)
    • Bug report template
    • Feature request template
    • Documentation improvement template
    • Config file with contact links
  • Create pull request template (.github/PULL_REQUEST_TEMPLATE.md)
  • Review and ensure welcoming, inclusive tone throughout
  • Verify all templates work correctly

Completed:

✅ CODE_OF_CONDUCT.md - Following Contributor Covenant 2.1 standard

  • Comprehensive conduct standards
  • Clear enforcement guidelines with 4-level response
  • Community impact descriptions
  • Proper attribution

✅ CONTRIBUTING.md - Enhanced with complete contributor guidance

  • Welcoming introduction with first-time contributor resources
  • 6 ways to contribute (bugs, features, docs, code, tests, reviews)
  • Detailed development setup (Docker + manual)
  • Discord application setup guide
  • Development workflow and git best practices
  • Issue guidelines with lifecycle explanation
  • Community guidelines and communication tips
  • Recognition section

✅ Issue Templates - Using modern YAML forms

  • Bug Report: Comprehensive with preflight checklist, component selection, environment dropdown, and contribution checkbox
  • Feature Request: Includes problem statement, use cases, priority levels, and mockup section
  • Documentation: Focused template for doc improvements with location field
  • Config: Links to discussions, documentation, and security advisories

✅ Pull Request Template - Comprehensive checklist-based template

  • Type of change selection (11 types)
  • Related issues linking
  • Testing checklist and environment selection
  • 10-point contributor checklist
  • Additional sections: breaking changes, performance, security, deployment notes

✅ README.md Updates

  • Added welcoming contributions message
  • Reference to Code of Conduct
  • Prettier formatting applied

✅ SECURITY.md Updates

  • Updated vulnerability reporting to use GitHub Security Advisories
  • Clear guidance on preferred reporting methods

✅ All YAML templates validated - Passed Python YAML validation

Summary:

All contributing guidelines and templates have been created following open source best practices. The documentation provides a welcoming, inclusive environment for contributors of all skill levels. Templates are production-ready and follow GitHub's recommended patterns.

Original prompt

This section details on the original issue you should resolve

<issue_title>Contributing Guidelines - Open Source Standards</issue_title>
<issue_description>## 🎯 Objective Create contributing guidelines for open source contributors. ## 📋 Requirements - Code of conduct - Contribution process documentation - Pull request guidelines - Issue and PR templates - Development standards ## 🎯 Success Criteria - Clear guidelines published - Templates created and working - Process well-documented - Welcoming and inclusive tone ## ⏱️ Estimated Effort 1-2 days</issue_description>

Comments on the Issue (you are @copilot in this section)

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

## Contributing Guidelines - Open Source Standards Creating comprehensive contributing guidelines following open source best practices. ### Plan: - [x] Create comprehensive CODE_OF_CONDUCT.md based on Contributor Covenant - [x] Enhance CONTRIBUTING.md with more details on contribution process - [x] Create issue templates (.github/ISSUE_TEMPLATE/) - [x] Bug report template - [x] Feature request template - [x] Documentation improvement template - [x] Config file with contact links - [x] Create pull request template (.github/PULL_REQUEST_TEMPLATE.md) - [x] Review and ensure welcoming, inclusive tone throughout - [x] Verify all templates work correctly ### Completed: ✅ **CODE_OF_CONDUCT.md** - Following Contributor Covenant 2.1 standard - Comprehensive conduct standards - Clear enforcement guidelines with 4-level response - Community impact descriptions - Proper attribution ✅ **CONTRIBUTING.md** - Enhanced with complete contributor guidance - Welcoming introduction with first-time contributor resources - 6 ways to contribute (bugs, features, docs, code, tests, reviews) - Detailed development setup (Docker + manual) - Discord application setup guide - Development workflow and git best practices - Issue guidelines with lifecycle explanation - Community guidelines and communication tips - Recognition section ✅ **Issue Templates** - Using modern YAML forms - **Bug Report**: Comprehensive with preflight checklist, component selection, environment dropdown, and contribution checkbox - **Feature Request**: Includes problem statement, use cases, priority levels, and mockup section - **Documentation**: Focused template for doc improvements with location field - **Config**: Links to discussions, documentation, and security advisories ✅ **Pull Request Template** - Comprehensive checklist-based template - Type of change selection (11 types) - Related issues linking - Testing checklist and environment selection - 10-point contributor checklist - Additional sections: breaking changes, performance, security, deployment notes ✅ **README.md Updates** - Added welcoming contributions message - Reference to Code of Conduct - Prettier formatting applied ✅ **SECURITY.md Updates** - Updated vulnerability reporting to use GitHub Security Advisories - Clear guidance on preferred reporting methods ✅ **All YAML templates validated** - Passed Python YAML validation ### Summary: All contributing guidelines and templates have been created following open source best practices. The documentation provides a welcoming, inclusive environment for contributors of all skill levels. Templates are production-ready and follow GitHub's recommended patterns. <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>Contributing Guidelines - Open Source Standards</issue_title> > <issue_description>## 🎯 Objective Create contributing guidelines for open source contributors. ## 📋 Requirements - Code of conduct - Contribution process documentation - Pull request guidelines - Issue and PR templates - Development standards ## 🎯 Success Criteria - Clear guidelines published - Templates created and working - Process well-documented - Welcoming and inclusive tone ## ⏱️ Estimated Effort 1-2 days</issue_description> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details> - Fixes subculture-collective/discord-spywatcher#49 <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey).
onnwee (Migrated from github.com) reviewed 2025-11-03 20:57:50 -06:00
copilot-pull-request-reviewer[bot] (Migrated from github.com) reviewed 2025-11-04 15:40:12 -06:00
copilot-pull-request-reviewer[bot] (Migrated from github.com) left a comment
Copy Link

Pull Request Overview

This pull request standardizes code formatting across all Markdown documentation files by converting inconsistent indentation (mixed 2-space and 4-space tabs) to a uniform 4-space indentation style. The changes improve code readability and maintain consistency throughout the project's documentation.

Key changes:

  • Standardized indentation in code blocks (TypeScript, JavaScript, SQL, YAML, Bash) to 4 spaces
  • Normalized nested list indentation to 4 spaces
  • Added blank lines after section headers for improved readability
  • Fixed minor table formatting inconsistencies

Reviewed Changes

Copilot reviewed 31 out of 33 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
WEBSOCKET_API.md Standardized code block indentation from 2 to 4 spaces
SENTRY.md Normalized YAML code block indentation
SECURITY.md Fixed nested list indentation in security reporting section
SDK_IMPLEMENTATION.md Standardized indentation in code examples and tables
REDIS_CACHING.md Unified TypeScript and Bash code block formatting
README.md Normalized table formatting and code examples
RATE_LIMITING.md Standardized JSON response indentation and table alignment
QUERY_OPTIMIZATIONS.md Fixed SQL query indentation and table formatting
PRIVACY_ANALYTICS.md Normalized nested list indentation
POSTGRESQL_MIGRATION_SUMMARY.md Standardized table and code block formatting
POSTGRESQL.md Fixed TypeScript examples and SQL query indentation
PLUGIN_SYSTEM.md Normalized JSON and JavaScript code block indentation
MONITORING.md Standardized YAML and JSON formatting
MIGRATION.md Fixed nested list and code block indentation
LOGGING.md Normalized LogQL and configuration examples
INFRASTRUCTURE.md Standardized table alignment and nested lists
HEALTH_STATUS.md Fixed JSON response indentation
DOCKER.md Normalized Bash commands and nested list formatting
DISASTER_RECOVERY.md Standardized code blocks and nested lists
DATABASE_OPTIMIZATION.md Fixed SQL and TypeScript indentation
CONTRIBUTING.md Significantly expanded with new sections and standardized formatting
CONNECTION_POOLING.md Normalized TypeScript and configuration examples
CODE_OF_CONDUCT.md New file added with standard Contributor Covenant
BACKUP.md Standardized Bash and SQL code blocks
ANALYTICS.md Fixed TypeScript import statements and code formatting
ADVANCED_VISUALIZATIONS.md Normalized nested list indentation
ACCESSIBILITY.md Fixed table and nested list formatting
.gitignore Removed trailing whitespace
.github/PULL_REQUEST_TEMPLATE.md New comprehensive PR template added
.github/ISSUE_TEMPLATE/feature_request.yml New feature request template
.github/ISSUE_TEMPLATE/documentation.yml New documentation improvement template
.github/ISSUE_TEMPLATE/config.yml New issue template configuration
.github/ISSUE_TEMPLATE/bug_report.yml New bug report template

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## Pull Request Overview This pull request standardizes code formatting across all Markdown documentation files by converting inconsistent indentation (mixed 2-space and 4-space tabs) to a uniform 4-space indentation style. The changes improve code readability and maintain consistency throughout the project's documentation. **Key changes:** - Standardized indentation in code blocks (TypeScript, JavaScript, SQL, YAML, Bash) to 4 spaces - Normalized nested list indentation to 4 spaces - Added blank lines after section headers for improved readability - Fixed minor table formatting inconsistencies ### Reviewed Changes Copilot reviewed 31 out of 33 changed files in this pull request and generated 1 comment. <details> <summary>Show a summary per file</summary> | File | Description | | ---- | ----------- | | WEBSOCKET_API.md | Standardized code block indentation from 2 to 4 spaces | | SENTRY.md | Normalized YAML code block indentation | | SECURITY.md | Fixed nested list indentation in security reporting section | | SDK_IMPLEMENTATION.md | Standardized indentation in code examples and tables | | REDIS_CACHING.md | Unified TypeScript and Bash code block formatting | | README.md | Normalized table formatting and code examples | | RATE_LIMITING.md | Standardized JSON response indentation and table alignment | | QUERY_OPTIMIZATIONS.md | Fixed SQL query indentation and table formatting | | PRIVACY_ANALYTICS.md | Normalized nested list indentation | | POSTGRESQL_MIGRATION_SUMMARY.md | Standardized table and code block formatting | | POSTGRESQL.md | Fixed TypeScript examples and SQL query indentation | | PLUGIN_SYSTEM.md | Normalized JSON and JavaScript code block indentation | | MONITORING.md | Standardized YAML and JSON formatting | | MIGRATION.md | Fixed nested list and code block indentation | | LOGGING.md | Normalized LogQL and configuration examples | | INFRASTRUCTURE.md | Standardized table alignment and nested lists | | HEALTH_STATUS.md | Fixed JSON response indentation | | DOCKER.md | Normalized Bash commands and nested list formatting | | DISASTER_RECOVERY.md | Standardized code blocks and nested lists | | DATABASE_OPTIMIZATION.md | Fixed SQL and TypeScript indentation | | CONTRIBUTING.md | Significantly expanded with new sections and standardized formatting | | CONNECTION_POOLING.md | Normalized TypeScript and configuration examples | | CODE_OF_CONDUCT.md | New file added with standard Contributor Covenant | | BACKUP.md | Standardized Bash and SQL code blocks | | ANALYTICS.md | Fixed TypeScript import statements and code formatting | | ADVANCED_VISUALIZATIONS.md | Normalized nested list indentation | | ACCESSIBILITY.md | Fixed table and nested list formatting | | .gitignore | Removed trailing whitespace | | .github/PULL_REQUEST_TEMPLATE.md | New comprehensive PR template added | | .github/ISSUE_TEMPLATE/feature_request.yml | New feature request template | | .github/ISSUE_TEMPLATE/documentation.yml | New documentation improvement template | | .github/ISSUE_TEMPLATE/config.yml | New issue template configuration | | .github/ISSUE_TEMPLATE/bug_report.yml | New bug report template | </details> --- 💡 <a href="/subculture-collective/discord-spywatcher/new/main/.github/instructions?filename=*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
WEBSOCKET_API.md
@@ -227,9 +245,10 @@ Receives notifications when a user's roles change in the guild.
```
copilot-pull-request-reviewer[bot] (Migrated from github.com) commented 2025-11-04 15:40:11 -06:00
Copy Link

This line appears to be a duplicate field. Line 143 already includes timestamp: string; within the data object. Line 145 should be removed as it creates an invalid TypeScript interface with a duplicate property at the same level as guildId and data.

This line appears to be a duplicate field. Line 143 already includes `timestamp: string;` within the `data` object. Line 145 should be removed as it creates an invalid TypeScript interface with a duplicate property at the same level as `guildId` and `data`.
Sign in to join this conversation.
Reviewers
No Reviewers
onnwee
copilot-pull-request-reviewer[bot]
Labels
Clear labels
P0-critical
P1-high
P2-medium
P3-low
Low priority
 accessibility
analytics
api
authentication
backend
bug
Something isn't working
 ci/cd
code-quality
compliance
database
dependencies
Pull requests that update a dependency file
 deployment
design
documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 feature
frontend
good first issue
Good for newcomers
 help wanted
Extra attention is needed
 infrastructure
invalid
This doesn't seem right
 javascript
Pull requests that update javascript code
 milestone-api
milestone-database
milestone-deployment
milestone-docs
milestone-features
milestone-foundation
milestone-frontend
milestone-monitoring
milestone-security
monitoring
observability
operations
performance
question
Further information is requested
 real-time
roadmap
security
testing
tracking
wontfix
This will not be worked on
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
onnwee
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: subculture-collective/discord-spywatcher#170
Delete Branch "copilot/add-contributing-guidelines"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?