go-micro.dev/v5@v5.12.0/internal/website/docs/contributing.md (about)

     1  ---
     2  layout: default
     3  ---
     4  
     5  # Contributing
     6  
     7  This is a rendered copy of the repository `CONTRIBUTING.md` for convenient access via the documentation site.
     8  
     9  ## Overview
    10  
    11  Go Micro welcomes contributions of all kinds: code, documentation, examples, and plugins.
    12  
    13  ## Quick Start
    14  
    15  ```bash
    16  git clone https://github.com/micro/go-micro.git
    17  cd go-micro
    18  go mod download
    19  go test ./...
    20  ```
    21  
    22  ## Process
    23  
    24  1. Fork and create a feature branch
    25  2. Make focused changes with tests
    26  3. Run linting and full test suite
    27  4. Open a PR describing motivation and approach
    28  
    29  ## Commit Format
    30  
    31  Use conventional commits:
    32  
    33  ```
    34  feat(registry): add consul health check
    35  fix(broker): prevent reconnect storm
    36  ```
    37  
    38  ## Testing
    39  
    40  Run unit tests:
    41  ```bash
    42  go test ./...
    43  ```
    44  Run race/coverage:
    45  ```bash
    46  go test -race -coverprofile=coverage.out ./...
    47  ```
    48  
    49  ## Plugins
    50  
    51  Place new plugins under the appropriate interface directory (e.g. `registry/consul/`). Include tests and usage examples. Document env vars and options.
    52  
    53  ## Documentation
    54  
    55  Docs live in `internal/website/docs/`. Add new examples under `internal/website/docs/examples/`.
    56  
    57  ## Help & Questions
    58  
    59  Use GitHub Discussions or the issue templates. For general usage questions open a "Question" issue.
    60  
    61  ## Full Guide
    62  
    63  For complete details see the repository copy of the guide on GitHub.
    64  
    65  - View on GitHub: https://github.com/micro/go-micro/blob/master/CONTRIBUTING.md