github.com/iamlotus/docker@v1.8.1/docs/project/who-written-for.md (about)

     1  <!--[metadata]>
     2  +++
     3  title = "README first"
     4  description = "Introduction to project contribution at Docker"
     5  keywords = ["Gordon, introduction, turtle, machine, libcontainer,  how to"]
     6  [menu.main]
     7  parent = "smn_develop"
     8  +++
     9  <![end-metadata]-->
    10  
    11  # README first
    12  
    13  This section of the documentation contains a guide for Docker users who want to
    14  contribute code or documentation to the Docker project. As a community, we
    15  share rules of behavior and interaction. Make sure you are familiar with the <a
    16  href="https://github.com/docker/docker/blob/master/CONTRIBUTING.md#docker-community-guidelines"
    17  target="_blank">community guidelines</a> before continuing.
    18  
    19  ## Where and what you can contribute
    20  
    21  The Docker project consists of not just one but several repositories on GitHub.
    22  So, in addition to the `docker/docker` repository, there is the
    23  `docker/compose` repo, the `docker/machine` repo, and several more.
    24  Contribute to any of these and you contribute to the Docker project.
    25  
    26  Not all Docker repositories use the Go language. Also, each repository has its
    27  own focus area. So, if you are an experienced contributor, think about
    28  contributing to a Docker repository that has a language or a focus area you are
    29  familiar with.
    30  
    31  If you are new to the open source community, to Docker, or to formal
    32  programming, you should start out contributing to the `docker/docker`
    33  repository. Why? Because this guide is written for that repository specifically.
    34  
    35  Finally, code or documentation isn't the only way to contribute. You can report
    36  an issue, add to discussions in our community channel, write a blog post, or
    37  take a usability test. You can even propose your own type of contribution.
    38  Right now we don't have a lot written about this yet, so just email
    39  <mailto:feedback@docker.com> if this type of contributing interests you.
    40  
    41  ## A turtle is involved
    42  
    43  ![Gordon](/project/images/gordon.jpeg)
    44  
    45  Enough said.
    46  
    47  ## How to use this guide
    48  
    49  This is written for the distracted, the overworked, the sloppy reader with fair
    50  `git` skills and a failing memory for the GitHub GUI. The guide attempts to
    51  explain how to use the Docker environment as precisely, predictably, and
    52  procedurally as possible.
    53  
    54  Users who are new to the Docker development environment should start by setting
    55  up their environment. Then, they should try a simple code change. After that,
    56  you should find something to work on or propose at totally new change.
    57  
    58  If you are a programming prodigy, you still may find this documentation useful.
    59  Please feel free to skim past information you find obvious or boring.
    60  
    61  ## How to get started
    62  
    63  Start by [getting the software you need to contribute](/project/software-required/).