www.aleph1.co.uk Git - yaffs-website/blob - vendor/drupal/console/CONTRIBUTING.md

   1 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
   2 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
   3
   4 - [Issue title](#issue-title)
   5 - [Problem/Motivation](#problemmotivation)
   6 - [How to reproduce](#how-to-reproduce)
   7 - [Solution](#solution)
   8 - [Minimum Requirements](#minimum-requirements)
   9 - [Support](#support)
  10 - [Documentation](#documentation)
  11
  12 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
  13
  14 ### Issue title
  15
  16 The issue title should comply with the following structure:
  17
  18 [ *ISSUE-GROUP* ] Short description
  19
  20 The *ISSUE-GROUP* should be one of:
  21
  22 * `command:name`
  23 * `console`
  24 * `helper`
  25 * `standard`
  26 * `template`
  27 * `translation`
  28 * `test`
  29 * `docs`
  30
  31 ### Problem/Motivation
  32 A brief statement describing why the issue was filed.
  33
  34 **Details to include:**
  35 - Why are we doing this? Above all, a summary should explain why a change is needed, in a few short sentences.
  36
  37 ### How to reproduce
  38 Include steps related how to reproduce.
  39
  40 **Details to include:**
  41 - Drupal version (you can obtain this by running `drupal site:status`).
  42 - Console version (you can obtain this by running `composer show | grep drupal/console`).
  43 - Console Launcher version (you can obtain this by running outside of a drupal site `drupal --version`).
  44 - Steps to reproduce
  45 - Include screen-shot or video whenever necessary.
  46
  47 ### Solution
  48 A brief description of the proposed fix.
  49
  50 **Details to include:**
  51 - A short summary of the approach proposed or used in the PR.
  52 - Approaches that have been tried and ruled out.
  53 - Links to relevant API documentation or other resources.
  54 - Known workarounds.
  55
  56 ### Minimum Requirements
  57 This project requires Drupal 8.
  58
  59 ### Support
  60 **Do not open issue for support question, only features and bugs.** For question please visit our [DrupalConsole Gitter room](https://gitter.im/hechoendrupal/DrupalConsole).
  61
  62 ### Documentation
  63 There's been some amazing Drupal Community work done around DrupalConsole. Many of your questions can be answered in our [DrupalConsole Book](https://www.gitbook.com/book/hechoendrupal/drupal-console/details).
  64
  65 If you find documentation in this DrupalConsole Book inaccurate or missing, you can created a new issue at [DrupalConsole Book](https://github.com/hechoendrupal/drupal-console-book) repository.