github.com/sams1990/dockerrepo@v17.12.1-ce-rc2+incompatible/docs/contributing/who-written-for.md (about)

     1  ### README first
     2  
     3  This section of the documentation contains a guide for Moby project users who want to
     4  contribute code or documentation to the Moby Engine project. As a community, we
     5  share rules of behavior and interaction. Make sure you are familiar with the <a
     6  href="https://github.com/moby/moby/blob/master/CONTRIBUTING.md#docker-community-guidelines"
     7  target="_blank">community guidelines</a> before continuing.
     8  
     9  ## Where and what you can contribute
    10  
    11  The Moby project consists of not just one but several repositories on GitHub.
    12  So, in addition to the `moby/moby` repository, there is the
    13  `containerd/containerd` repo, the `moby/buildkit` repo, and several more.
    14  Contribute to any of these and you contribute to the Moby project.
    15  
    16  Not all Moby repositories use the Go language. Also, each repository has its
    17  own focus area. So, if you are an experienced contributor, think about
    18  contributing to a Moby project repository that has a language or a focus area you are
    19  familiar with.
    20  
    21  If you are new to the open source community, to Moby, or to formal
    22  programming, you should start out contributing to the `moby/moby`
    23  repository. Why? Because this guide is written for that repository specifically.
    24  
    25  Finally, code or documentation isn't the only way to contribute. You can report
    26  an issue, add to discussions in our community channel, write a blog post, or
    27  take a usability test. You can even propose your own type of contribution.
    28  Right now we don't have a lot written about this yet, but feel free to open an issue
    29  to discuss other contributions.
    30  
    31  ## How to use this guide
    32  
    33  This is written for the distracted, the overworked, the sloppy reader with fair
    34  `git` skills and a failing memory for the GitHub GUI. The guide attempts to
    35  explain how to use the Moby Engine development environment as precisely,
    36  predictably, and procedurally as possible.
    37  
    38  Users who are new to Engine development should start by setting up their
    39  environment. Then, they should try a simple code change. After that, you should
    40  find something to work on or propose a totally new change.
    41  
    42  If you are a programming prodigy, you still may find this documentation useful.
    43  Please feel free to skim past information you find obvious or boring.
    44  
    45  ## How to get started
    46  
    47  Start by getting the software you require. If you are on Mac or Linux, go to
    48  [get the required software for Linux or macOS](software-required.md). If you are
    49  on Windows, see [get the required software for Windows](software-req-win.md).