Skip to content

feat(module): Community Standards & Documentation Infrastructure #15

Description

@vernonthedev

Area

modules

NestForge Version

1.3.0

Rust Version

rustc1.8

Module Proposal

To transition NestForge from a personal project to a professional open-source ecosystem, we need to implement a standardized "Community Health" suite. This ensures that every contributor at Veike Agency and the wider GitHub community follows the same architectural patterns, coding standards, and communication protocols. This issue tracks the creation and integration of all legal, social, and technical documentation files.

User Story

As a NestForge maintainer, I want clear community guidelines and standardized issue templates so that I can spend less time managing poor-quality tickets and more time building high-performance Rust features.

DI and Module Graph Spec

Proposed Workflow

  1. Repository Health: Initialize the .github/ root directory with the core community files (CODE_OF_CONDUCT, CONTRIBUTING, SECURITY).
  2. Issue/PR Templating: Implement the YAML-based "Issue Forms" for Bugs and Features to replace the generic Markdown templates.
  3. Discussions Onboarding: Set up the category descriptions and "Welcome" pinned posts for Announcements, Ideas, Q&A, and Polls.
  4. Automation: Configure labeler.yml to automatically tag incoming PRs based on modified files (e.g., tags /core for src/nestforge-core).

Modular Compatibility

Technical Tasks

  • Community Core: Create CODE_OF_CONDUCT.md using the Contributor Covenant v2.1.
  • Contribution Guide: Draft CONTRIBUTING.md including the Rust style guide and "Flat Folder" architecture rules.
  • Issue Forms: Implement .github/ISSUE_TEMPLATE/bug_report.yml and feature_request.yml.
  • Pull Request Template: Create .github/pull_request_template.md with a mandatory "Performance Impact" checklist.
  • Security Policy: Create SECURITY.md defining how to report vulnerabilities in the NestForge framework.
  • Discussion Setup: Finalize the "Welcome" descriptions for all 5 categories (Announcements, Ideas, Q&A, Show & Tell, Polls).

Performance Considerations

Success Criteria

  • A "Community" score of 100% on the GitHub repository insights tab.
  • New contributors are automatically presented with the CONTRIBUTING.md link when opening a PR.
  • Issue creation uses structured forms instead of blank text areas.

Labels

/governance /documentation /dx /priority-high

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions