Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (72 loc) · 4.32 KB

CONTRIBUTING.md

File metadata and controls

90 lines (72 loc) · 4.32 KB

Contribution Guide High-Level Structure

This Contribution Guide outlines the process for contributing effectively and consistently across all projects. It consists of a main overview file and multiple detailed documents, each covering a specific area. The main guide links to each of these documents for ease of access.

Sections

  1. Introduction

    • Purpose and Scope
    • Expectations for Contributors

  2. Getting Started

    • How to Contribute
    • Prerequisites
    • Setting Up Your Environment

  3. Repository Structure and Navigation

    • Common Repository Layouts (App / DB / IaC / GitHub Actions)
    • Navigating Source Code, Docs, and Modules
    • Folder Purpose and Descriptions

  4. Naming Conventions and Standards

    • Common Conventions (kebab-case, PascalCase, camelCase)
    • Application, Executable, Solution, and Project Names
    • Azure Resource Naming Conventions
    • GitHub Organization and Project Naming
    • CLI Command & Parameter Naming (Silent Mode Standards)

  5. Branching Strategy

    • Forking and Branching
    • Branch Naming Convention
    • Main, Development, Feature, Hotfix Flow

  6. Commit Guidelines

    • Commit Message Format and Structure
    • Naming Conventions and Action Verbs
    • Examples and Templates

  7. Pull Request (PR) Process

    • PR Title Conventions
    • Description Standards
    • Review and Approval Workflow
    • Labeling and Status Handling
    • Squash and Merge Policy

  8. Code Review Standards

    • Review Checklist
    • Constructive Feedback and Responsibilities
    • Review Turnaround Expectations (e.g., 2–3 days)
    • Best Practices and Continuous Improvement

  9. Code Style

    • Formatting Guidelines
    • Linting Tools and Configuration
    • File and Directory Naming Standards

  10. Testing Guidelines

    • Unit, Integration, and E2E Testing Expectations
    • Test Folder Structure
    • Automation and CI Requirements

  11. Documentation Standards

    • Markdown Best Practices
    • Image and Screenshot Guidelines
    • Folder and File Naming within /docs

  12. Issue Management

    • GitHub Issue Title Format
    • Templates and Label Usage
    • Workflow for Tracking Bugs, Features, Tasks

  13. Community Engagement

    • Using GitHub Discussions
    • Commenting and Participating Respectfully
    • Labeling and Tagging Topics Properly

  14. Release Management

    • GitHub Release Process (Preparation → Post-Release)
    • Semantic Versioning
    • Changelog and Asset Attachments
    • Release Note Template

  15. Support and Contact

    • Help Channels
    • Reporting Process
    • Contributor Roles and Escalation Paths

  16. Code of Conduct

    • Community Behavior Expectations
    • Reporting Violations
    • Enforcement Process