Skip to content

Add community health files and templates for consistent contributions #37

@coisa

Description

@coisa

Objective

Create default community health files and templates to guide contributors and users when opening issues and pull requests.

Current Limitation

The repository lacks standardized templates and community files, leading to inconsistent issue reports and pull requests that require more effort to triage and process.

Proposed Work

Create the following files following GitHub best practices:

Community Health Files (1-4)

  1. CODE_OF_CONDUCT.md - Define standards for community engagement
  2. CONTRIBUTING.md - Document how to contribute to the project
  3. SECURITY.md - Provide instructions for reporting vulnerabilities
  4. SUPPORT.md - Let contributors know how to get help

Issue Templates (5-7)

Create .github/ISSUE_TEMPLATE/ with:
5. bug-report.yml - Bug report form with required fields
6. feature-request.yml - Feature request form
7. config.yml - Template configuration

Pull Request Template (8)

  1. .github/pull_request_template.md - Standard PR description format

Scope

  • In-scope items:
    • All 8 files listed above
    • Follow GitHub supported formats and syntax
    • Align with Fast Forward project conventions
    • Place in .github/ root for this repository
  • Non-goals:
    • Discussion category forms
    • FUNDING.yml (already exists)
    • GOVERNANCE.md

Requirements

  • CODE_OF_CONDUCT.md must include:
    • Code of conduct text (Contributor Covenant v2.1 or similar)
    • Enforcement guidelines
    • Contact information for reporting
  • CONTRIBUTING.md must include:
    • Development setup instructions
    • Coding standards reference
    • PR process and conventions
    • Link to dev-tools commands
  • SECURITY.md must include:
    • Reporting instructions
    • Supported versions
    • Response timeline expectations
  • SUPPORT.md must include:
    • How to get help
    • Links to documentation
    • Community channels
  • Issue forms must use YAML syntax with:
    • Required fields validation
    • Labels for categorization
    • Helpful placeholders
  • PR template must follow:
    • Summary/Changes/Testing sections
    • Issue closing reference
    • [area] title prefix convention

Acceptance Criteria

  • CODE_OF_CONDUCT.md exists and is properly formatted
  • CONTRIBUTING.md exists with development workflow documentation
  • SECURITY.md exists with vulnerability reporting process
  • SUPPORT.md exists with help resources
  • Bug issue template captures: steps to reproduce, expected vs actual behavior, environment
  • Feature request template captures: problem, proposed solution, alternatives considered
  • Pull request template includes: summary, changes, testing, closes reference
  • All templates are validated and functional

Documentation / Content Criteria

  • All files must follow repository naming conventions
  • Links must be accurate and functional
  • Content must be consistent with Fast Forward project values
  • Templates must be user-friendly with clear instructions

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions