github.com/xdlianrong208/docker-ce-comments@v17.12.1-ce-rc2+incompatible/CONTRIBUTING.md (about)

     1  # Contributing to Docker CE
     2  
     3  Want to contribute on Docker CE? Awesome!
     4  
     5  This page contains information about reporting issues as well as some tips and
     6  guidelines useful to experienced open source contributors. Finally, make sure
     7  you read our [community guidelines](#docker-community-guidelines) before you
     8  start participating.
     9  
    10  ## Topics
    11  
    12  * [Reporting Security Issues](#reporting-security-issues)
    13  * [Reporting Issues](#reporting-other-issues)
    14  * [Submitting Pull Requests](#submitting-pull-requests)
    15  * [Community Guidelines](#docker-community-guidelines)
    16  
    17  ## Reporting security issues
    18  
    19  The Docker maintainers take security seriously. If you discover a security
    20  issue, please bring it to their attention right away!
    21  
    22  Please **DO NOT** file a public issue, instead send your report privately to
    23  [security@docker.com](mailto:security@docker.com).
    24  
    25  Security reports are greatly appreciated and we will publicly thank you for it.
    26  We also like to send gifts—if you're into Docker schwag, make sure to let
    27  us know. We currently do not offer a paid security bounty program, but are not
    28  ruling it out in the future.
    29  
    30  ## Reporting other issues
    31  
    32  There are separate issue-tracking repos for the end user Docker CE
    33  products specialized for a platform. Find your issue or file a new issue
    34  for the platform you are using:
    35  
    36  * https://github.com/docker/for-linux
    37  * https://github.com/docker/for-mac
    38  * https://github.com/docker/for-win
    39  * https://github.com/docker/for-aws
    40  * https://github.com/docker/for-azure
    41  
    42  When reporting issues, always include:
    43  
    44  * The output of `docker version`.
    45  * The output of `docker info`.
    46  
    47  If presented with a template when creating an issue, please follow its directions.
    48  
    49  Also include the steps required to reproduce the problem if possible and
    50  applicable. This information will help us review and fix your issue faster.
    51  When sending lengthy log-files, consider posting them as a gist (https://gist.github.com).
    52  Don't forget to remove sensitive data from your logfiles before posting (you can
    53  replace those parts with "REDACTED").
    54  
    55  ## Submitting pull requests
    56  
    57  Please see the corresponding `CONTRIBUTING.md` file of each component for more information:
    58  
    59  * Changes to the `engine` should be directed upstream to https://github.com/moby/moby
    60  * Changes to the `cli` should be directed upstream to https://github.com/docker/cli
    61  * Changes to the `packaging` should be directed upstream to https://github.com/docker/docker-ce-packaging
    62  
    63  ## Docker community guidelines
    64  
    65  We want to keep the Docker community awesome, growing and collaborative. We need
    66  your help to keep it that way. To help with this we've come up with some general
    67  guidelines for the community as a whole:
    68  
    69  * Be nice: Be courteous, respectful and polite to fellow community members.
    70    Regional, racial, gender, or other abuse will not be tolerated. We like
    71    nice people way better than mean ones!
    72  
    73  * Encourage diversity and participation: Make everyone in our community feel
    74    welcome, regardless of their background and the extent of their
    75    contributions, and do everything possible to encourage participation in
    76    our community.
    77  
    78  * Keep it legal: Basically, don't get us in trouble. Share only content that
    79    you own, do not share private or sensitive information, and don't break
    80    the law.
    81  
    82  * Stay on topic: Make sure that you are posting to the correct channel and
    83    avoid off-topic discussions. Remember when you update an issue or respond
    84    to an email you are potentially sending to a large number of people. Please
    85    consider this before you update. Also remember that nobody likes spam.
    86  
    87  * Don't send email to the maintainers: There's no need to send email to the
    88    maintainers to ask them to investigate an issue or to take a look at a
    89    pull request. Instead of sending an email, GitHub mentions should be
    90    used to ping maintainers to review a pull request, a proposal or an
    91    issue.
    92  
    93  ### Guideline violations — 3 strikes method
    94  
    95  The point of this section is not to find opportunities to punish people, but we
    96  do need a fair way to deal with people who are making our community suck.
    97  
    98  1. First occurrence: We'll give you a friendly, but public reminder that the
    99     behavior is inappropriate according to our guidelines.
   100  
   101  2. Second occurrence: We will send you a private message with a warning that
   102     any additional violations will result in removal from the community.
   103  
   104  3. Third occurrence: Depending on the violation, we may need to delete or ban
   105     your account.
   106  
   107  **Notes:**
   108  
   109  * Obvious spammers are banned on first occurrence. If we don't do this, we'll
   110    have spam all over the place.
   111  
   112  * Violations are forgiven after 6 months of good behavior, and we won't hold a
   113    grudge.
   114  
   115  * People who commit minor infractions will get some education, rather than
   116    hammering them in the 3 strikes process.
   117  
   118  * The rules apply equally to everyone in the community, no matter how much
   119          you've contributed.
   120  
   121  * Extreme violations of a threatening, abusive, destructive or illegal nature
   122          will be addressed immediately and are not subject to 3 strikes or forgiveness.
   123  
   124  * Contact abuse@docker.com to report abuse or appeal violations. In the case of
   125          appeals, we know that mistakes happen, and we'll work with you to come up with a
   126          fair solution if there has been a misunderstanding.