├── .dockerignore ├── .gitignore ├── Dockerfile ├── Jenkinsfile ├── MAINTAINERS ├── Makefile ├── README.md ├── docs └── README.md ├── maintainercollector ├── generate.go ├── main.go ├── roles.toml ├── rules.toml └── types.go └── project-template ├── CONTRIBUTING.md ├── INSTRUCTIONS.md ├── LICENSE.code ├── LICENSE.docs ├── MAINTAINERS └── README.md /.dockerignore: -------------------------------------------------------------------------------- 1 | .git 2 | docs 3 | MAINTAINERS 4 | README.md 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ###Go### 2 | 3 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 4 | *.o 5 | *.a 6 | *.so 7 | *.swo 8 | *.swp 9 | 10 | # Folders 11 | _obj 12 | _test 13 | 14 | # Architecture specific extensions/prefixes 15 | *.[568vq] 16 | [568vq].out 17 | 18 | *.cgo1.go 19 | *.cgo2.c 20 | _cgo_defun.c 21 | _cgo_gotypes.go 22 | _cgo_export.* 23 | 24 | _testmain.go 25 | 26 | *.exe 27 | *.test 28 | 29 | 30 | ###OSX### 31 | 32 | .DS_Store 33 | .AppleDouble 34 | .LSOverride 35 | 36 | # Icon must ends with two \r. 37 | Icon 38 | 39 | 40 | # Thumbnails 41 | ._* 42 | Thumb.db 43 | 44 | # Files that might appear on external disk 45 | .Spotlight-V100 46 | .Trashes 47 | 48 | maintainers/maintainers 49 | maintainers/MAINTAINERS 50 | 51 | # go generated files 52 | maintainers/rules.go 53 | maintainers/roles.go 54 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine 2 | 3 | ENV PATH /go/bin:/usr/local/go/bin:$PATH 4 | ENV GOPATH /go 5 | 6 | RUN apk add --no-cache ca-certificates 7 | 8 | COPY . /go/src/github.com/docker/opensource 9 | 10 | ENV GO111MODULE=off 11 | 12 | RUN buildDeps=' \ 13 | go \ 14 | git \ 15 | gcc \ 16 | libc-dev \ 17 | libgcc \ 18 | ' \ 19 | set -x \ 20 | && apk update \ 21 | && apk add $buildDeps \ 22 | && cd /go/src/github.com/docker/opensource \ 23 | && go get github.com/BurntSushi/toml \ 24 | && go get github.com/sirupsen/logrus \ 25 | && go generate ./maintainercollector \ 26 | && go build -o /usr/bin/maintainercollector ./maintainercollector \ 27 | && apk del $buildDeps \ 28 | && rm -rf /var/cache/apk/* \ 29 | && rm -rf /go \ 30 | && echo "Build complete." 31 | 32 | WORKDIR /root/maintainers 33 | 34 | ENTRYPOINT [ "maintainercollector" ] 35 | -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | // Only run on Linux atm 2 | wrappedNode(label: 'linux') { 3 | deleteDir() 4 | stage "checkout" 5 | checkout scm 6 | 7 | documentationChecker("docs") 8 | } 9 | -------------------------------------------------------------------------------- /MAINTAINERS: -------------------------------------------------------------------------------- 1 | # 2 | # THIS FILE IS AUTOGENERATED; SEE "./maintainercollector"! 3 | # 4 | # Docker projects maintainers file 5 | # 6 | # This file describes who runs the Docker project and how. 7 | # This is a living document - if you see something out of date or missing, 8 | # speak up! 9 | # 10 | # It is structured to be consumable by both humans and programs. 11 | # To extract its contents programmatically, use any TOML-compliant 12 | # parser. 13 | [Rules] 14 | 15 | [Rules.maintainers] 16 | 17 | title = "What is a maintainer?" 18 | 19 | text = """ 20 | There are different types of maintainers, with different responsibilities, but 21 | all maintainers have 3 things in common: 22 | 23 | 1) They share responsibility in the project's success. 24 | 2) They have made a long-term, recurring time investment to improve the project. 25 | 3) They spend that time doing whatever needs to be done, not necessarily what 26 | is the most interesting or fun. 27 | 28 | Maintainers are often under-appreciated, because their work is harder to appreciate. 29 | It's easy to appreciate a really cool and technically advanced feature. It's harder 30 | to appreciate the absence of bugs, the slow but steady improvement in stability, 31 | or the reliability of a release process. But those things distinguish a good 32 | project from a great one. 33 | """ 34 | [Rules.adding-maintainers] 35 | 36 | title = "How are maintainers added?" 37 | 38 | text = """ 39 | Maintainers are first and foremost contributors that have shown they are 40 | committed to the long term success of a project. Contributors wanting to 41 | become maintainers are expected to be deeply involved in contributing code, 42 | pull request review, and triage of issues in the project for more than three 43 | months. 44 | 45 | Just contributing does not make you a maintainer, it is about building trust 46 | with the current maintainers of the project and being a person that they can 47 | depend on and trust to make decisions in the best interest of the project. 48 | 49 | Maintainers are assigned per project (repository). Being a maintainer in 50 | one project does not automatically make you a maintainer in other projects. 51 | 52 | Periodically, the existing maintainers curate a list of contributors that have 53 | shown regular activity on the project over the prior months. From this 54 | list, maintainer candidates are selected and proposed on the maintainers 55 | mailing list. 56 | 57 | After a candidate has been announced on the maintainers mailing list, the 58 | existing maintainers are given five business days to discuss the candidate, 59 | raise objections and cast their vote. Candidates must be approved by the BDFL 60 | and at least 66% of the current maintainers by adding their vote on the mailing 61 | list. Only maintainers of the repository that the candidate is proposed for are 62 | allowed to vote. The BDFL's vote is mandatory. 63 | 64 | If a candidate is approved, a maintainer will contact the candidate to 65 | invite the candidate to open a pull request that adds the contributor to 66 | the MAINTAINERS file. The candidate becomes a maintainer once the pull 67 | request is merged. 68 | """ 69 | 70 | [Rules.stepping-down-policy] 71 | 72 | title = "Stepping down policy" 73 | 74 | text = """ 75 | Life priorities, interests, and passions can change. If you're a maintainer but 76 | feel you must remove yourself from the list, inform other maintainers that you 77 | intend to step down, and if possible, help find someone to pick up your work. 78 | At the very least, ensure your work can be continued where you left off. 79 | 80 | After you've informed other maintainers, create a pull request to remove 81 | yourself from the MAINTAINERS file. 82 | """ 83 | 84 | [Rules.inactive-maintainers] 85 | 86 | title = "Removal of inactive maintainers" 87 | 88 | text = """ 89 | Similar to the procedure for adding new maintainers, existing maintainers can 90 | be removed from the list if they do not show significant activity on the 91 | project. Periodically, the maintainers review the list of maintainers and their 92 | activity over the last three months. 93 | 94 | If a maintainer has shown insufficient activity over this period, a neutral 95 | person will contact the maintainer to ask if they want to continue being 96 | a maintainer. If the maintainer decides to step down as a maintainer, they 97 | open a pull request to be removed from the MAINTAINERS file. 98 | 99 | If the maintainer wants to remain a maintainer, but is unable to perform the 100 | required duties they can be removed with a vote by the BDFL and at least 66% of 101 | the current maintainers. The BDFL's vote is mandatory. An e-mail is sent to the 102 | mailing list, inviting maintainers of the project to vote. The voting period is 103 | five business days. Issues related to a maintainer's performance should be 104 | discussed with them among the other maintainers so that they are not surprised 105 | by a pull request removing them. 106 | """ 107 | 108 | [Rules.alumni] 109 | 110 | title = "Alumni" 111 | 112 | text = """ 113 | Projects can opt to keep a list of former maintainers in the MAINTAINERS file. 114 | Instead of removing a maintainer from the file when they step down, the maintainer 115 | is moved to the alumni list (`[Org.Alumni]`). People on this list have 116 | no official capacity in the project, it's a way to say "thank you" for the 117 | work they have done for the project. 118 | """ 119 | 120 | [Rules.bdfl] 121 | 122 | title = "The Benevolent dictator for life (BDFL)" 123 | 124 | text = """ 125 | Docker follows the timeless, highly efficient and totally unfair system 126 | known as [Benevolent dictator for 127 | life](https://en.wikipedia.org/wiki/Benevolent_Dictator_for_Life), with 128 | yours truly, Solomon Hykes, in the role of BDFL. This means that all 129 | decisions are made, by default, by Solomon. Since making every decision 130 | myself would be highly un-scalable, in practice decisions are spread 131 | across multiple maintainers. 132 | 133 | Ideally, the BDFL role is like the Queen of England: awesome crown, but not 134 | an actual operational role day-to-day. The real job of a BDFL is to NEVER GO AWAY. 135 | Every other rule can change, perhaps drastically so, but the BDFL will always 136 | be there, preserving the philosophy and principles of the project, and keeping 137 | ultimate authority over its fate. This gives us great flexibility in experimenting 138 | with various governance models, knowing that we can always press the "reset" button 139 | without fear of fragmentation or deadlock. See the US congress for a counter-example. 140 | 141 | BDFL daily routine: 142 | 143 | * Is the project governance stuck in a deadlock or irreversibly fragmented? 144 | * If yes: refactor the project governance 145 | * Are there issues or conflicts escalated by core? 146 | * If yes: resolve them 147 | * Go back to polishing that crown. 148 | """ 149 | 150 | [Rules.decisions] 151 | 152 | title = "How are decisions made?" 153 | 154 | text = """ 155 | Short answer: EVERYTHING IS A PULL REQUEST. 156 | 157 | Docker is an open-source project with an open design philosophy. This 158 | means that the repository is the source of truth for EVERY aspect of the 159 | project, including its philosophy, design, road map, and APIs. *If it's 160 | part of the project, it's in the repo. If it's in the repo, it's part of 161 | the project.* 162 | 163 | As a result, all decisions can be expressed as changes to the 164 | repository. An implementation change is a change to the source code. An 165 | API change is a change to the API specification. A philosophy change is 166 | a change to the philosophy manifesto, and so on. 167 | 168 | All decisions affecting Docker, big and small, follow the same 3 steps: 169 | 170 | * Step 1: Open a pull request. Anyone can do this. 171 | 172 | * Step 2: Discuss the pull request. Anyone can do this. 173 | 174 | * Step 3: Merge or refuse the pull request. Who does this depends on the nature 175 | of the pull request and which areas of the project it affects. See *review flow* 176 | for details. 177 | 178 | Because Docker is such a large and active project, it's important for everyone to know 179 | who is responsible for deciding what. That is determined by a precise set of rules. 180 | 181 | * For every *decision* in the project, the rules should designate, in a deterministic way, 182 | who should *decide*. 183 | 184 | * For every *problem* in the project, the rules should designate, in a deterministic way, 185 | who should be responsible for *fixing* it. 186 | 187 | * For every *question* in the project, the rules should designate, in a deterministic way, 188 | who should be expected to have the *answer*. 189 | """ 190 | 191 | [Rules.review] 192 | 193 | title = "Review flow" 194 | 195 | text = """ 196 | Pull requests should be processed according to the following flow: 197 | 198 | * For each subsystem affected by the change, the maintainers of the subsystem must approve or refuse it. 199 | It is the responsibility of the subsystem maintainers to process patches affecting them in a timely 200 | manner. 201 | 202 | * If the change affects areas of the code which are not part of a subsystem, 203 | or if subsystem maintainers are unable to reach a timely decision, it must be approved by 204 | the core maintainers. 205 | 206 | * If the change affects the UI or public APIs, or if it represents a major change in architecture, 207 | the architects must approve or refuse it. 208 | 209 | * If the change affects the operations of the project, it must be approved or rejected by 210 | the relevant operators. 211 | 212 | * If the change affects the governance, philosophy, goals or principles of the project, 213 | it must be approved by BDFL. 214 | """ 215 | 216 | [Rules.DCO] 217 | 218 | title = "Helping contributors with the DCO" 219 | 220 | text = """ 221 | The [DCO or `Sign your work`]( 222 | https://github.com/docker/docker/blob/master/CONTRIBUTING.md#sign-your-work) 223 | requirement is not intended as a roadblock or speed bump. 224 | 225 | Some Docker contributors are not as familiar with `git`, or have used a web based 226 | editor, and thus asking them to `git commit --amend -s` is not the best way forward. 227 | 228 | In this case, maintainers can update the commits based on clause (c) of the DCO. The 229 | most trivial way for a contributor to allow the maintainer to do this, is to add 230 | a DCO signature in a pull requests's comment, or a maintainer can simply note that 231 | the change is sufficiently trivial that it does not substantially change the existing 232 | contribution - i.e., a spelling change. 233 | 234 | When you add someone's DCO, please also add your own to keep a log. 235 | """ 236 | 237 | [Rules."no direct push"] 238 | 239 | title = "I'm a maintainer. Should I make pull requests too?" 240 | 241 | text = """ 242 | Yes. Nobody should ever push to master directly. All changes should be 243 | made through a pull request. 244 | """ 245 | 246 | [Rules.meta] 247 | 248 | title = "How is this process changed?" 249 | 250 | text = "Just like everything else: by making a pull request :)" 251 | 252 | 253 | # Current project roles 254 | [Roles] 255 | 256 | [Roles.bdfl] 257 | 258 | person = "shykes" 259 | 260 | [Roles."Chief Architect"] 261 | 262 | person = "shykes" 263 | 264 | text = """ 265 | The chief architect is responsible for the overall integrity of the technical architecture 266 | across all subsystems, and the consistency of APIs and UI. 267 | 268 | Changes to UI, public APIs and overall architecture (for example a plugin system) must 269 | be approved by the chief architect. 270 | """ 271 | 272 | [Roles."Chief Maintainer"] 273 | 274 | person = "crosbymichael" 275 | 276 | text = """ 277 | The chief maintainer is responsible for all aspects of quality for the project including 278 | code reviews, usability, stability, security, performance, etc. 279 | The most important function of the chief maintainer is to lead by example. On the first 280 | day of a new maintainer, the best advice should be "follow the C.M.'s example and you'll 281 | be fine". 282 | """ 283 | 284 | [Roles."Community Manager"] 285 | 286 | people = ["thajeztah", "vcoisne"] 287 | 288 | text = """ 289 | The community manager is responsible for serving the project community, including users, 290 | contributors and partners. This involves: 291 | - facilitating communication between maintainers, contributors and users 292 | - organizing contributor and maintainer events 293 | - helping new contributors get involved 294 | - anything the project community needs to be successful 295 | 296 | The community manager is a point of contact for any contributor who has questions, concerns 297 | or feedback about project operations. 298 | """ 299 | 300 | 301 | [Org] 302 | [Org.Curators] 303 | People = ["alexellis", "andrewhsu", "bsousaa", "crazy-max", "fntlnz", "gianarb", "olljanat", "programmerq", "ripcurld", "rumpl", "sam-thibault", "samwhited", "thajeztah", "vvoland"] 304 | [Org."Docs maintainers"] 305 | People = [] 306 | [Org.cli] 307 | People = ["albers", "cpuguy83", "ndeloof", "rumpl", "silvin-lubecki", "stevvooe", "thajeztah", "tibor", "tonistiigi", "vdemeester", "vieux"] 308 | [Org.compose] 309 | People = ["aiordache", "ndeloof", "rumpl", "ulyssessouza"] 310 | [Org.datakit] 311 | People = ["avsm", "samoht", "talex5"] 312 | [Org.docker-bench-security] 313 | People = ["diogomonica", "konstruktoid"] 314 | [Org.docker-credential-helpers] 315 | People = ["coolljt0725", "cpuguy83", "crosbymichael", "dnephin", "duglin", "estesp", "jhowardmsft", "mavenugo", "mhbauer", "n4ss", "runcom", "stevvooe", "thajeztah", "tianon", "tibor", "tonistiigi", "unclejack", "vdemeester", "vieux"] 316 | [Org.docker-py] 317 | People = ["aiordache", "ulyssessouza"] 318 | [Org.dockercraft] 319 | People = ["aduermael", "dave-tucker", "gdevillele"] 320 | [Org.go-connections] 321 | People = ["akihirosuda", "dnephin", "thajeztah", "vdemeester"] 322 | [Org.go-events] 323 | People = ["aaronlehmann", "aluzzardi", "lk4d4", "stevvooe"] 324 | [Org.go-plugins-helpers] 325 | People = ["calavera", "dave-tucker", "runcom"] 326 | [Org.go-units] 327 | People = ["akihirosuda", "dnephin", "thajeztah", "vdemeester"] 328 | [Org.hyperkit] 329 | People = ["avsm", "djs55", "dsheets", "ebriney", "gdevillele", "ijc", "justincormack", "magnuss", "rn", "samoht"] 330 | [Org.libchan] 331 | People = ["dmcgowan", "shykes"] 332 | [Org.libkv] 333 | People = ["aluzzardi", "sanimej", "vieux"] 334 | [Org.libnetwork] 335 | People = ["arkodg", "euanh", "fcrisciani", "mavenugo", "selansen"] 336 | [Org.linuxkit] 337 | People = ["dave-tucker", "deitch", "djs55", "ijc", "justincormack", "rn"] 338 | [Org.moby] 339 | People = ["akihirosuda", "anusha", "coolljt0725", "corhere", "cpuguy83", "estesp", "johnstep", "justincormack", "kolyshkin", "mhbauer", "neersighted", "runcom", "samuelkarp", "stevvooe", "thajeztah", "tianon", "tibor", "tonistiigi", "unclejack", "vdemeester", "vieux", "yongtang"] 340 | [Org.notary] 341 | [Org.spdystream] 342 | People = ["adisky", "dims", "dmcgowan"] 343 | [Org.swarmkit] 344 | People = ["aaronlehmann", "aluzzardi", "amitshukla", "anshulpundir", "cyli", "diogomonica", "dongluochen", "dperny", "lk4d4", "stevvooe", "thajeztah", "tonistiigi", "vieux", "yongtang"] 345 | [Org.vpnkit] 346 | People = ["avsm", "djs55", "ebriney", "fredericdalleau", "guillaumerose", "samoht"] 347 | 348 | [People] 349 | [People.aanand] 350 | Name = "Aanand Prasad" 351 | Email = "aanand@docker.com" 352 | GitHub = "aanand" 353 | [People.aaronlehmann] 354 | Name = "Aaron Lehmann" 355 | Email = "aaron.lehmann@docker.com" 356 | GitHub = "aaronlehmann" 357 | [People.adisky] 358 | Name = "Aditi Sharma" 359 | Email = "adi.sky17@gmail.com" 360 | GitHub = "adisky" 361 | [People.aduermael] 362 | Name = "Adrien Duermael" 363 | Email = "adrien@docker.com" 364 | GitHub = "aduermael" 365 | [People.aiordache] 366 | Name = "Anca Iordache" 367 | Email = "anca.iordache@docker.com" 368 | GitHub = "aiordache" 369 | [People.akihirosuda] 370 | Name = "Akihiro Suda" 371 | Email = "akihiro.suda.cz@hco.ntt.co.jp" 372 | GitHub = "AkihiroSuda" 373 | [People.albers] 374 | Name = "Harald Albers" 375 | Email = "github@albersweb.de" 376 | GitHub = "albers" 377 | [People.alexellis] 378 | Name = "Alex Ellis" 379 | Email = "alexellis2@gmail.com" 380 | GitHub = "alexellis" 381 | [People.aluzzardi] 382 | Name = "Andrea Luzzardi" 383 | Email = "al@docker.com" 384 | GitHub = "aluzzardi" 385 | [People.amitshukla] 386 | Name = "Amit Shukla" 387 | Email = "amit.shukla@docker.com" 388 | GitHub = "amitshukla" 389 | [People.andrewhsu] 390 | Name = "Andrew Hsu" 391 | Email = "andrewhsu@docker.com" 392 | GitHub = "andrewhsu" 393 | [People.anshulpundir] 394 | Name = "Anshul Pundir" 395 | Email = "anshul.x.pundir@gmail.com" 396 | GitHub = "anshulpundir" 397 | [People.anusha] 398 | Name = "Anusha Ragunathan" 399 | Email = "anusha@docker.com" 400 | GitHub = "anusha-ragunathan" 401 | [People.arkodg] 402 | Name = "Arko Dasgupta" 403 | Email = "arko.dasgupta@docker.com" 404 | GitHub = "arkodg" 405 | [People.avsm] 406 | Name = "Anil Madhavapeddy" 407 | Email = "anil@recoil.org" 408 | GitHub = "avsm" 409 | [People.bfirsh] 410 | Name = "Ben Firshman" 411 | Email = "b@fir.sh" 412 | GitHub = "bfirsh" 413 | [People.bsousaa] 414 | Name = "Bruno de Sousa" 415 | Email = "bruno.sousa@docker.com" 416 | GitHub = "bsousaa" 417 | [People.calavera] 418 | Name = "David Calavera" 419 | Email = "david.calavera@gmail.com" 420 | GitHub = "calavera" 421 | [People.coolljt0725] 422 | Name = "Lei Jitang" 423 | Email = "leijitang@huawei.com" 424 | GitHub = "coolljt0725" 425 | [People.corhere] 426 | Name = "Cory Snider" 427 | Email = "csnider@mirantis.com" 428 | GitHub = "corhere" 429 | [People.cpuguy83] 430 | Name = "Brian Goff" 431 | Email = "cpuguy83@gmail.com" 432 | GitHub = "cpuguy83" 433 | [People.crazy-max] 434 | Name = "Kevin Alvarez" 435 | Email = "contact@crazymax.dev" 436 | GitHub = "crazy-max" 437 | [People.crosbymichael] 438 | Name = "Michael Crosby" 439 | Email = "crosbymichael@gmail.com" 440 | GitHub = "crosbymichael" 441 | [People.cyli] 442 | Name = "Ying Li" 443 | Email = "ying.li@docker.com" 444 | GitHub = "cyli" 445 | [People.dave-tucker] 446 | Name = "Dave Tucker" 447 | Email = "dave@dtucker.co.uk" 448 | GitHub = "dave-tucker" 449 | [People.deitch] 450 | Name = "Avi Deitcher" 451 | Email = "avi@atomicinc.com" 452 | GitHub = "deitch" 453 | [People.dims] 454 | Name = "Davanum Srinivas" 455 | Email = "davanum@gmail.com" 456 | GitHub = "dims" 457 | [People.diogomonica] 458 | Name = "Diogo Monica" 459 | Email = "diogo@docker.com" 460 | GitHub = "diogomonica" 461 | [People.djs55] 462 | Name = "David Scott" 463 | Email = "dave.scott@docker.com" 464 | GitHub = "djs55" 465 | [People.dmcgowan] 466 | Name = "Derek McGowan" 467 | Email = "derek@mcg.dev" 468 | GitHub = "dmcgowan" 469 | [People.dnephin] 470 | Name = "Daniel Nephin" 471 | Email = "dnephin@gmail.com" 472 | GitHub = "dnephin" 473 | [People.dongluochen] 474 | Name = "Dongluo Chen" 475 | Email = "dong@docker.com" 476 | GitHub = "dongluochen" 477 | [People.dperny] 478 | Name = "Drew Erny" 479 | Email = "drew.erny@docker.com" 480 | GitHub = "dperny" 481 | [People.dsheets] 482 | Name = "David Sheets" 483 | Email = "dsheets@docker.com" 484 | GitHub = "dsheets" 485 | [People.duglin] 486 | Name = "Doug Davis" 487 | Email = "dug@us.ibm.com" 488 | GitHub = "duglin" 489 | [People.ebriney] 490 | Name = "Emmanuel Briney" 491 | Email = "emmanuel.briney@docker.com" 492 | GitHub = "ebriney" 493 | [People.ehazlett] 494 | Name = "Evan Hazlett" 495 | Email = "ejhazlett@gmail.com" 496 | GitHub = "ehazlett" 497 | [People.erikh] 498 | Name = "Erik Hollensbe" 499 | Email = "erik@docker.com" 500 | GitHub = "erikh" 501 | [People.estesp] 502 | Name = "Phil Estes" 503 | Email = "estesp@linux.vnet.ibm.com" 504 | GitHub = "estesp" 505 | [People.euanh] 506 | Name = "Euan Harris" 507 | Email = "euan.harris@docker.com" 508 | GitHub = "euanh" 509 | [People.fcrisciani] 510 | Name = "Flavio Crisciani" 511 | Email = "flavio.crisciani@docker.com" 512 | GitHub = "fcrisciani" 513 | [People.fntlnz] 514 | Name = "Lorenzo Fontana" 515 | Email = "fontanalorenz@gmail.com" 516 | GitHub = "fntlnz" 517 | [People.fredericdalleau] 518 | Name = "Frederic Dalleau" 519 | Email = "frederic.dalleau@docker.com" 520 | GitHub = "fredericdalleau" 521 | [People.gdevillele] 522 | Name = "Gaetan de Villele" 523 | Email = "gdevillele@gmail.com" 524 | GitHub = "gdevillele" 525 | [People.gianarb] 526 | Name = "Gianluca Arbezzano" 527 | Email = "ga@thumpflow.com" 528 | GitHub = "gianarb" 529 | [People.guillaumerose] 530 | Name = "Guillaume Rose" 531 | Email = "guillaume.rose@gmail.com" 532 | GitHub = "guillaumerose" 533 | [People.hukeping] 534 | Name = "Hu Keping" 535 | Email = "hukeping@huawei.com" 536 | GitHub = "hukeping" 537 | [People.icecrime] 538 | Name = "Arnaud Porterie" 539 | Email = "icecrime@gmail.com" 540 | GitHub = "icecrime" 541 | [People.ijc] 542 | Name = "Ian Campbell" 543 | Email = "ian.campbell@docker.com" 544 | GitHub = "ijc" 545 | [People.jamtur01] 546 | Name = "James Turnbull" 547 | Email = "james@lovedthanlost.net" 548 | GitHub = "jamtur01" 549 | [People.jessfraz] 550 | Name = "Jessie Frazelle" 551 | Email = "jess@linux.com" 552 | GitHub = "jessfraz" 553 | [People.jhowardmsft] 554 | Name = "John Howard" 555 | Email = "jhoward@microsoft.com" 556 | GitHub = "jhowardmsft" 557 | [People.johnstep] 558 | Name = "John Stephens" 559 | Email = "johnstep@docker.com" 560 | GitHub = "johnstep" 561 | [People.justincormack] 562 | Name = "Justin Cormack" 563 | Email = "justin.cormack@docker.com" 564 | GitHub = "justincormack" 565 | [People.kolyshkin] 566 | Name = "Kir Kolyshkin" 567 | Email = "kolyshkin@gmail.com" 568 | GitHub = "kolyshkin" 569 | [People.konstruktoid] 570 | Name = "Thomas Sjögren" 571 | Email = "thomas.sjogren@protonmail.com" 572 | GitHub = "konstruktoid" 573 | [People.lk4d4] 574 | Name = "Alexander Morozov" 575 | Email = "lk4d4@docker.com" 576 | GitHub = "lk4d4" 577 | [People.lowenna] 578 | Name = "John Howard" 579 | Email = "github@lowenna.com" 580 | GitHub = "lowenna" 581 | [People.magnuss] 582 | Name = "Magnus Skjegstad" 583 | Email = "magnus@skjegstad.com" 584 | GitHub = "MagnusS" 585 | [People.mavenugo] 586 | Name = "Madhu Venugopal" 587 | Email = "madhu@docker.com" 588 | GitHub = "mavenugo" 589 | [People.mefyl] 590 | Name = "Quentin Hocquet" 591 | Email = "quentin.hocquet@docker.com" 592 | GitHub = "mefyl" 593 | [People.mhbauer] 594 | Name = "Morgan Bauer" 595 | Email = "mbauer@us.ibm.com" 596 | GitHub = "mhbauer" 597 | [People.misty] 598 | Name = "Misty Stanley-Jones" 599 | Email = "misty@docker.com" 600 | GitHub = "mistyhacks" 601 | [People.mlaventure] 602 | Name = "Kenfe-Mickaël Laventure" 603 | Email = "mickael.laventure@gmail.com" 604 | GitHub = "mlaventure" 605 | [People.mnm678] 606 | Name = "Marina Moore" 607 | Email = "mm9693@nyu.edu" 608 | GitHub = "mnm678" 609 | [People.mnottale] 610 | Name = "Matthieu Nottale" 611 | Email = "matthieu.nottale@docker.com" 612 | GitHub = "mnottale" 613 | [People.mnowster] 614 | Name = "Mazz Mosley" 615 | Email = "mazz@houseofmnowster.com" 616 | GitHub = "mnowster" 617 | [People.moxiegirl] 618 | Name = "Mary Anthony" 619 | Email = "mary.anthony@docker.com" 620 | GitHub = "moxiegirl" 621 | [People.mpetazzoni] 622 | Name = "Maxime Petazzoni" 623 | Email = "maxime.petazzoni@bulix.org" 624 | GitHub = "mpetazzoni" 625 | [People.mrjana] 626 | Name = "Jana Radhakrishnan" 627 | Email = "mrjana@docker.com" 628 | GitHub = "mrjana" 629 | [People.n4ss] 630 | Name = "Nassim Eddequiouaq" 631 | Email = "eddequiouaq.nassim@gmail.com" 632 | GitHub = "n4ss" 633 | [People.ndeloof] 634 | Name = "Nicolas De Loof" 635 | Email = "nicolas.deloof@gmail.com" 636 | GitHub = "ndeloof" 637 | [People.neersighted] 638 | Name = "Bjorn Neergaard" 639 | Email = "bneergaard@mirantis.com" 640 | GitHub = "neersighted" 641 | [People.niazfk] 642 | Name = "Niaz Khan" 643 | Email = "niazfk@amazon.com" 644 | GitHub = "niazfk" 645 | [People.olljanat] 646 | Name = "Olli Janatuinen" 647 | Email = "olli.janatuinen@gmail.com" 648 | GitHub = "olljanat" 649 | [People.programmerq] 650 | Name = "Jeff Anderson" 651 | Email = "jeff@docker.com" 652 | GitHub = "programmerq" 653 | [People.ripcurld] 654 | Name = "Boaz Shuster" 655 | Email = "ripcurld.github@gmail.com" 656 | GitHub = "ripcurld" 657 | [People.riyazdf] 658 | Name = "Riyaz Faizullabhoy" 659 | Email = "riyaz@docker.com" 660 | GitHub = "riyazdf" 661 | [People.rn] 662 | Name = "Rolf Neugebauer" 663 | Email = "rn@rneugeba.io" 664 | GitHub = "rn" 665 | [People.rumpl] 666 | Name = "Djordje Lukic" 667 | Email = "djordje.lukic@docker.com" 668 | GitHub = "rumpl" 669 | [People.runcom] 670 | Name = "Antonio Murdaca" 671 | Email = "runcom@redhat.com" 672 | GitHub = "runcom" 673 | [People.sam-thibault] 674 | Name = "Sam Thibault" 675 | Email = "sam.thibault@docker.com" 676 | GitHub = "sam-thibault" 677 | [People.samoht] 678 | Name = "Thomas Gazagnaire" 679 | Email = "thomas@gazagnaire.org" 680 | GitHub = "samoht" 681 | [People.samuelkarp] 682 | Name = "Samuel Karp" 683 | Email = "me@samuelkarp.com" 684 | GitHub = "samuelkarp" 685 | [People.samwhited] 686 | Name = "Sam Whited" 687 | Email = "sam@samwhited.com" 688 | GitHub = "samwhited" 689 | [People.sanimej] 690 | Name = "Santhosh Manohar" 691 | Email = "santhosh@docker.com" 692 | GitHub = "sanimej" 693 | [People.selansen] 694 | Name = "Elangovan Sivanandam" 695 | Email = "elango.siva@docker.com" 696 | GitHub = "selansen" 697 | [People.shin-] 698 | Name = "Joffrey F" 699 | Email = "joffrey@docker.com" 700 | GitHub = "shin-" 701 | [People.shykes] 702 | Name = "Solomon Hykes" 703 | Email = "solomon@docker.com" 704 | GitHub = "shykes" 705 | [People.silvin-lubecki] 706 | Name = "Silvin Lubecki" 707 | Email = "silvin.lubecki@docker.com" 708 | GitHub = "silvin-lubecki" 709 | [People.stevelasker] 710 | Name = "Steve Lasker" 711 | Email = "Steve.Lasker@microsoft.com" 712 | GitHub = "stevelasker" 713 | [People.stevvooe] 714 | Name = "Stephen Day" 715 | Email = "stephen.day@docker.com" 716 | GitHub = "stevvooe" 717 | [People.sven] 718 | Name = "Sven Dowideit" 719 | Email = "SvenDowideit@home.org.au" 720 | GitHub = "SvenDowideit" 721 | [People.talex5] 722 | Name = "Thomas Leonard" 723 | Email = "thomas.leonard@docker.com" 724 | GitHub = "talex5" 725 | [People.thajeztah] 726 | Name = "Sebastiaan van Stijn" 727 | Email = "github@gone.nl" 728 | GitHub = "thaJeztah" 729 | [People.tianon] 730 | Name = "Tianon Gravi" 731 | Email = "admwiggin@gmail.com" 732 | GitHub = "tianon" 733 | [People.tibor] 734 | Name = "Tibor Vass" 735 | Email = "tibor@docker.com" 736 | GitHub = "tiborvass" 737 | [People.tonistiigi] 738 | Name = "Tõnis Tiigi" 739 | Email = "tonis@docker.com" 740 | GitHub = "tonistiigi" 741 | [People.ulyssessouza] 742 | Name = "Ulysses Domiciano Souza" 743 | Email = "ulysses.souza@docker.com" 744 | GitHub = "ulyssessouza" 745 | [People.unclejack] 746 | Name = "Cristian Staretu" 747 | Email = "cristian.staretu@gmail.com" 748 | GitHub = "unclejack" 749 | [People.vbatts] 750 | Name = "Vincent Batts" 751 | Email = "vbatts@redhat.com" 752 | GitHub = "vbatts" 753 | [People.vdemeester] 754 | Name = "Vincent Demeester" 755 | Email = "vincent@sbr.pm" 756 | GitHub = "vdemeester" 757 | [People.vieux] 758 | Name = "Victor Vieux" 759 | Email = "vieux@docker.com" 760 | GitHub = "vieux" 761 | [People.vishh] 762 | Name = "Vishnu Kannan" 763 | Email = "vishnuk@google.com" 764 | GitHub = "vishh" 765 | [People.vvoland] 766 | Name = "Paweł Gronowski" 767 | Email = "pawel.gronowski@docker.com" 768 | GitHub = "vvoland" 769 | [People.yongtang] 770 | Name = "Yong Tang" 771 | Email = "yong.tang.github@outlook.com" 772 | GitHub = "yongtang" 773 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: maintainers 2 | 3 | maintainers: 4 | @docker build --rm --force-rm -t docker/maintainers . 5 | @docker run --rm -v $(CURDIR):/root/maintainers docker/maintainers 6 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | This repo contains documentation and scripts related to the management of Open Source at Docker. 2 | 3 | The compiled list of maintainers of all Docker subprojects can be found at 4 | [MAINTAINERS](MAINTAINERS). 5 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | # The docs have been moved! 2 | 3 | The documentation for Open Source has been merged into 4 | [the general documentation repo](https://github.com/docker/docker.github.io). 5 | 6 | The docs for Open Source are now here: 7 | https://github.com/docker/docker.github.io/tree/master/opensource 8 | 9 | As always, the docs remain open-source and we appreciate your feedback and 10 | pull requests! 11 | -------------------------------------------------------------------------------- /maintainercollector/generate.go: -------------------------------------------------------------------------------- 1 | // +build ignore 2 | 3 | package main 4 | 5 | import ( 6 | "fmt" 7 | "io/ioutil" 8 | "os" 9 | "path/filepath" 10 | ) 11 | 12 | func main() { 13 | wd, err := os.Getwd() 14 | if err != nil { 15 | panic(err) 16 | } 17 | 18 | if err := generateFile(wd, "rules.toml", "rules"); err != nil { 19 | panic(err) 20 | } 21 | 22 | if err := generateFile(wd, "roles.toml", "roles"); err != nil { 23 | panic(err) 24 | } 25 | } 26 | 27 | func generateFile(wd string, file string, target string) error { 28 | src, err := ioutil.ReadFile(file) 29 | if err != nil { 30 | panic(err) 31 | } 32 | out, err := os.Create(filepath.Join(wd, target+".go")) 33 | if err != nil { 34 | return err 35 | } 36 | out.Write([]byte("// This file is autogenerated; DO NOT EDIT DIRECTLY\n// See maintainercollector/generate.go for more info\npackage main\n\nconst (\n")) 37 | 38 | out.Write([]byte(fmt.Sprintf("%s = %q", target, string(src)))) 39 | 40 | out.Write([]byte("\n)\n")) 41 | 42 | return nil 43 | } 44 | -------------------------------------------------------------------------------- /maintainercollector/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "io/ioutil" 7 | "net/http" 8 | "sort" 9 | "strings" 10 | 11 | "github.com/BurntSushi/toml" 12 | "github.com/sirupsen/logrus" 13 | ) 14 | 15 | const ( 16 | defaultOrg = "docker" 17 | ghRawUri = "https://raw.githubusercontent.com" 18 | head = `# 19 | # THIS FILE IS AUTOGENERATED; SEE "./maintainercollector"! 20 | # 21 | # Docker projects maintainers file 22 | # 23 | # This file describes who runs the Docker project and how. 24 | # This is a living document - if you see something out of date or missing, 25 | # speak up! 26 | # 27 | # It is structured to be consumable by both humans and programs. 28 | # To extract its contents programmatically, use any TOML-compliant 29 | # parser. 30 | ` 31 | ) 32 | 33 | var ( 34 | projects = []string{ 35 | "cli", 36 | "compose", 37 | "docker-bench-security", 38 | "docker-credential-helpers", 39 | "docker-py", 40 | "dockercraft", 41 | "go-connections", 42 | "go-events", 43 | "go-plugins-helpers", 44 | "go-units", 45 | "libchan", 46 | "libkv", 47 | "linuxkit/linuxkit", 48 | "moby/libnetwork", 49 | "moby/datakit", 50 | "moby/hyperkit", 51 | "moby/moby", 52 | "moby/vpnkit", 53 | "moby/swarmkit", 54 | "notaryproject/notary", 55 | "spdystream", 56 | } 57 | ) 58 | 59 | //go:generate go run generate.go 60 | 61 | func main() { 62 | // initialize the project MAINTAINERS file 63 | projectMaintainers := Maintainers{ 64 | Org: map[string]*Org{}, 65 | People: map[string]Person{}, 66 | } 67 | 68 | // initialize Curators 69 | projectMaintainers.Org["Curators"] = &Org{} 70 | projectMaintainers.Org["Docs maintainers"] = &Org{} 71 | 72 | // parse the MAINTAINERS file for each repo 73 | for _, p := range projects { 74 | org, project := getProjectOrg(p) 75 | maintainers, err := getMaintainers(org, project) 76 | if err != nil { 77 | logrus.Errorf("%s: parsing MAINTAINERS file failed: %v", project, err) 78 | continue 79 | } 80 | 81 | p := &Org{} 82 | if maintainers.Organization.Maintainers != nil { 83 | p.People = maintainers.Organization.Maintainers.People 84 | } else if maintainers.Organization.CoreMaintainers != nil { 85 | // create the Org object for the project 86 | p.People = maintainers.Organization.CoreMaintainers.People 87 | //p := &Org{ 88 | // // Repo: fmt.Sprintf("https://github.com/%s/%s", org, project), 89 | // // TODO: change this to: 90 | // // People: maintainers.Org["Core maintainers"].People, 91 | // // once MaintainersDepreciated is removed. 92 | // People: maintainers.Organization.CoreMaintainers.People, 93 | //} 94 | } 95 | 96 | // lowercase all maintainers nicks for consistency 97 | for i, n := range p.People { 98 | p.People[i] = strings.ToLower(n) 99 | } 100 | sort.Strings(p.People) 101 | 102 | projectMaintainers.Org[project] = p 103 | 104 | if maintainers.Organization.DocsMaintainers != nil { 105 | projectMaintainers.Org["Docs maintainers"].People = append(projectMaintainers.Org["Docs maintainers"].People, maintainers.Organization.DocsMaintainers.People...) 106 | } 107 | 108 | if maintainers.Organization.Curators != nil { 109 | projectMaintainers.Org["Curators"].People = append(projectMaintainers.Org["Curators"].People, maintainers.Organization.Curators.People...) 110 | } 111 | 112 | // iterate through the people and add them to compiled list 113 | for nick, person := range maintainers.People { 114 | projectMaintainers.People[strings.ToLower(nick)] = person 115 | } 116 | } 117 | 118 | projectMaintainers.Org["Curators"].People = removeDuplicates(projectMaintainers.Org["Curators"].People) 119 | projectMaintainers.Org["Docs maintainers"].People = removeDuplicates(projectMaintainers.Org["Docs maintainers"].People) 120 | 121 | // encode the result to a file 122 | buf := new(bytes.Buffer) 123 | t := toml.NewEncoder(buf) 124 | t.Indent = " " 125 | if err := t.Encode(projectMaintainers); err != nil { 126 | logrus.Fatalf("TOML encoding error: %v", err) 127 | } 128 | 129 | file := append([]byte(head), []byte(rules)...) 130 | file = append(file, []byte(roles)...) 131 | file = append(file, buf.Bytes()...) 132 | 133 | if err := ioutil.WriteFile("MAINTAINERS", file, 0755); err != nil { 134 | logrus.Fatal(err) 135 | } 136 | 137 | logrus.Infof("Successfully wrote new combined MAINTAINERS file.") 138 | } 139 | 140 | func removeDuplicates(slice []string) []string { 141 | seens := map[string]bool{} 142 | uniqs := []string{} 143 | for _, element := range slice { 144 | if _, seen := seens[element]; !seen { 145 | uniqs = append(uniqs, element) 146 | seens[element] = true 147 | } 148 | } 149 | sort.Strings(uniqs) 150 | return uniqs 151 | } 152 | 153 | // getProjectOrg splits a given project in GitHub organization and project/repository name. 154 | // If the given project does not have a GitHub organization, the default (`defaultOrg`) is used. 155 | func getProjectOrg(project string) (string, string) { 156 | org := defaultOrg 157 | p := strings.SplitN(project, "/", 2) 158 | if len(p) == 2 { 159 | org, project = p[0], p[1] 160 | } 161 | 162 | return org, project 163 | } 164 | 165 | func getMaintainers(org string, project string) (maintainers MaintainersDepreciated, err error) { 166 | fileUrl := fmt.Sprintf("%s/%s/%s/master/MAINTAINERS", ghRawUri, org, project) 167 | 168 | logrus.Infof("%s/%s: loading MAINTAINERS file from %v", org, project, fileUrl) 169 | 170 | resp, err := http.Get(fileUrl) 171 | if err != nil { 172 | return maintainers, fmt.Errorf("%s/%s: %v", org, project, err) 173 | } 174 | defer resp.Body.Close() 175 | 176 | file, err := ioutil.ReadAll(resp.Body) 177 | if err != nil { 178 | return maintainers, fmt.Errorf("%s/%s: %v", org, project, err) 179 | } 180 | 181 | if _, err := toml.Decode(string(file), &maintainers); err != nil { 182 | return maintainers, fmt.Errorf("%s/%s: parsing MAINTAINERS file failed: %v", org, project, err) 183 | } 184 | 185 | return maintainers, nil 186 | } 187 | -------------------------------------------------------------------------------- /maintainercollector/roles.toml: -------------------------------------------------------------------------------- 1 | # Current project roles 2 | [Roles] 3 | 4 | [Roles.bdfl] 5 | 6 | person = "shykes" 7 | 8 | [Roles."Chief Architect"] 9 | 10 | person = "shykes" 11 | 12 | text = """ 13 | The chief architect is responsible for the overall integrity of the technical architecture 14 | across all subsystems, and the consistency of APIs and UI. 15 | 16 | Changes to UI, public APIs and overall architecture (for example a plugin system) must 17 | be approved by the chief architect. 18 | """ 19 | 20 | [Roles."Chief Maintainer"] 21 | 22 | person = "crosbymichael" 23 | 24 | text = """ 25 | The chief maintainer is responsible for all aspects of quality for the project including 26 | code reviews, usability, stability, security, performance, etc. 27 | The most important function of the chief maintainer is to lead by example. On the first 28 | day of a new maintainer, the best advice should be "follow the C.M.'s example and you'll 29 | be fine". 30 | """ 31 | 32 | [Roles."Community Manager"] 33 | 34 | people = ["thajeztah", "vcoisne"] 35 | 36 | text = """ 37 | The community manager is responsible for serving the project community, including users, 38 | contributors and partners. This involves: 39 | - facilitating communication between maintainers, contributors and users 40 | - organizing contributor and maintainer events 41 | - helping new contributors get involved 42 | - anything the project community needs to be successful 43 | 44 | The community manager is a point of contact for any contributor who has questions, concerns 45 | or feedback about project operations. 46 | """ 47 | 48 | 49 | -------------------------------------------------------------------------------- /maintainercollector/rules.toml: -------------------------------------------------------------------------------- 1 | [Rules] 2 | 3 | [Rules.maintainers] 4 | 5 | title = "What is a maintainer?" 6 | 7 | text = """ 8 | There are different types of maintainers, with different responsibilities, but 9 | all maintainers have 3 things in common: 10 | 11 | 1) They share responsibility in the project's success. 12 | 2) They have made a long-term, recurring time investment to improve the project. 13 | 3) They spend that time doing whatever needs to be done, not necessarily what 14 | is the most interesting or fun. 15 | 16 | Maintainers are often under-appreciated, because their work is harder to appreciate. 17 | It's easy to appreciate a really cool and technically advanced feature. It's harder 18 | to appreciate the absence of bugs, the slow but steady improvement in stability, 19 | or the reliability of a release process. But those things distinguish a good 20 | project from a great one. 21 | """ 22 | [Rules.adding-maintainers] 23 | 24 | title = "How are maintainers added?" 25 | 26 | text = """ 27 | Maintainers are first and foremost contributors that have shown they are 28 | committed to the long term success of a project. Contributors wanting to 29 | become maintainers are expected to be deeply involved in contributing code, 30 | pull request review, and triage of issues in the project for more than three 31 | months. 32 | 33 | Just contributing does not make you a maintainer, it is about building trust 34 | with the current maintainers of the project and being a person that they can 35 | depend on and trust to make decisions in the best interest of the project. 36 | 37 | Maintainers are assigned per project (repository). Being a maintainer in 38 | one project does not automatically make you a maintainer in other projects. 39 | 40 | Periodically, the existing maintainers curate a list of contributors that have 41 | shown regular activity on the project over the prior months. From this 42 | list, maintainer candidates are selected and proposed on the maintainers 43 | mailing list. 44 | 45 | After a candidate has been announced on the maintainers mailing list, the 46 | existing maintainers are given five business days to discuss the candidate, 47 | raise objections and cast their vote. Candidates must be approved by the BDFL 48 | and at least 66% of the current maintainers by adding their vote on the mailing 49 | list. Only maintainers of the repository that the candidate is proposed for are 50 | allowed to vote. The BDFL's vote is mandatory. 51 | 52 | If a candidate is approved, a maintainer will contact the candidate to 53 | invite the candidate to open a pull request that adds the contributor to 54 | the MAINTAINERS file. The candidate becomes a maintainer once the pull 55 | request is merged. 56 | """ 57 | 58 | [Rules.stepping-down-policy] 59 | 60 | title = "Stepping down policy" 61 | 62 | text = """ 63 | Life priorities, interests, and passions can change. If you're a maintainer but 64 | feel you must remove yourself from the list, inform other maintainers that you 65 | intend to step down, and if possible, help find someone to pick up your work. 66 | At the very least, ensure your work can be continued where you left off. 67 | 68 | After you've informed other maintainers, create a pull request to remove 69 | yourself from the MAINTAINERS file. 70 | """ 71 | 72 | [Rules.inactive-maintainers] 73 | 74 | title = "Removal of inactive maintainers" 75 | 76 | text = """ 77 | Similar to the procedure for adding new maintainers, existing maintainers can 78 | be removed from the list if they do not show significant activity on the 79 | project. Periodically, the maintainers review the list of maintainers and their 80 | activity over the last three months. 81 | 82 | If a maintainer has shown insufficient activity over this period, a neutral 83 | person will contact the maintainer to ask if they want to continue being 84 | a maintainer. If the maintainer decides to step down as a maintainer, they 85 | open a pull request to be removed from the MAINTAINERS file. 86 | 87 | If the maintainer wants to remain a maintainer, but is unable to perform the 88 | required duties they can be removed with a vote by the BDFL and at least 66% of 89 | the current maintainers. The BDFL's vote is mandatory. An e-mail is sent to the 90 | mailing list, inviting maintainers of the project to vote. The voting period is 91 | five business days. Issues related to a maintainer's performance should be 92 | discussed with them among the other maintainers so that they are not surprised 93 | by a pull request removing them. 94 | """ 95 | 96 | [Rules.alumni] 97 | 98 | title = "Alumni" 99 | 100 | text = """ 101 | Projects can opt to keep a list of former maintainers in the MAINTAINERS file. 102 | Instead of removing a maintainer from the file when they step down, the maintainer 103 | is moved to the alumni list (`[Org.Alumni]`). People on this list have 104 | no official capacity in the project, it's a way to say "thank you" for the 105 | work they have done for the project. 106 | """ 107 | 108 | [Rules.bdfl] 109 | 110 | title = "The Benevolent dictator for life (BDFL)" 111 | 112 | text = """ 113 | Docker follows the timeless, highly efficient and totally unfair system 114 | known as [Benevolent dictator for 115 | life](https://en.wikipedia.org/wiki/Benevolent_Dictator_for_Life), with 116 | yours truly, Solomon Hykes, in the role of BDFL. This means that all 117 | decisions are made, by default, by Solomon. Since making every decision 118 | myself would be highly un-scalable, in practice decisions are spread 119 | across multiple maintainers. 120 | 121 | Ideally, the BDFL role is like the Queen of England: awesome crown, but not 122 | an actual operational role day-to-day. The real job of a BDFL is to NEVER GO AWAY. 123 | Every other rule can change, perhaps drastically so, but the BDFL will always 124 | be there, preserving the philosophy and principles of the project, and keeping 125 | ultimate authority over its fate. This gives us great flexibility in experimenting 126 | with various governance models, knowing that we can always press the "reset" button 127 | without fear of fragmentation or deadlock. See the US congress for a counter-example. 128 | 129 | BDFL daily routine: 130 | 131 | * Is the project governance stuck in a deadlock or irreversibly fragmented? 132 | * If yes: refactor the project governance 133 | * Are there issues or conflicts escalated by core? 134 | * If yes: resolve them 135 | * Go back to polishing that crown. 136 | """ 137 | 138 | [Rules.decisions] 139 | 140 | title = "How are decisions made?" 141 | 142 | text = """ 143 | Short answer: EVERYTHING IS A PULL REQUEST. 144 | 145 | Docker is an open-source project with an open design philosophy. This 146 | means that the repository is the source of truth for EVERY aspect of the 147 | project, including its philosophy, design, road map, and APIs. *If it's 148 | part of the project, it's in the repo. If it's in the repo, it's part of 149 | the project.* 150 | 151 | As a result, all decisions can be expressed as changes to the 152 | repository. An implementation change is a change to the source code. An 153 | API change is a change to the API specification. A philosophy change is 154 | a change to the philosophy manifesto, and so on. 155 | 156 | All decisions affecting Docker, big and small, follow the same 3 steps: 157 | 158 | * Step 1: Open a pull request. Anyone can do this. 159 | 160 | * Step 2: Discuss the pull request. Anyone can do this. 161 | 162 | * Step 3: Merge or refuse the pull request. Who does this depends on the nature 163 | of the pull request and which areas of the project it affects. See *review flow* 164 | for details. 165 | 166 | Because Docker is such a large and active project, it's important for everyone to know 167 | who is responsible for deciding what. That is determined by a precise set of rules. 168 | 169 | * For every *decision* in the project, the rules should designate, in a deterministic way, 170 | who should *decide*. 171 | 172 | * For every *problem* in the project, the rules should designate, in a deterministic way, 173 | who should be responsible for *fixing* it. 174 | 175 | * For every *question* in the project, the rules should designate, in a deterministic way, 176 | who should be expected to have the *answer*. 177 | """ 178 | 179 | [Rules.review] 180 | 181 | title = "Review flow" 182 | 183 | text = """ 184 | Pull requests should be processed according to the following flow: 185 | 186 | * For each subsystem affected by the change, the maintainers of the subsystem must approve or refuse it. 187 | It is the responsibility of the subsystem maintainers to process patches affecting them in a timely 188 | manner. 189 | 190 | * If the change affects areas of the code which are not part of a subsystem, 191 | or if subsystem maintainers are unable to reach a timely decision, it must be approved by 192 | the core maintainers. 193 | 194 | * If the change affects the UI or public APIs, or if it represents a major change in architecture, 195 | the architects must approve or refuse it. 196 | 197 | * If the change affects the operations of the project, it must be approved or rejected by 198 | the relevant operators. 199 | 200 | * If the change affects the governance, philosophy, goals or principles of the project, 201 | it must be approved by BDFL. 202 | """ 203 | 204 | [Rules.DCO] 205 | 206 | title = "Helping contributors with the DCO" 207 | 208 | text = """ 209 | The [DCO or `Sign your work`]( 210 | https://github.com/docker/docker/blob/master/CONTRIBUTING.md#sign-your-work) 211 | requirement is not intended as a roadblock or speed bump. 212 | 213 | Some Docker contributors are not as familiar with `git`, or have used a web based 214 | editor, and thus asking them to `git commit --amend -s` is not the best way forward. 215 | 216 | In this case, maintainers can update the commits based on clause (c) of the DCO. The 217 | most trivial way for a contributor to allow the maintainer to do this, is to add 218 | a DCO signature in a pull requests's comment, or a maintainer can simply note that 219 | the change is sufficiently trivial that it does not substantially change the existing 220 | contribution - i.e., a spelling change. 221 | 222 | When you add someone's DCO, please also add your own to keep a log. 223 | """ 224 | 225 | [Rules."no direct push"] 226 | 227 | title = "I'm a maintainer. Should I make pull requests too?" 228 | 229 | text = """ 230 | Yes. Nobody should ever push to master directly. All changes should be 231 | made through a pull request. 232 | """ 233 | 234 | [Rules.meta] 235 | 236 | title = "How is this process changed?" 237 | 238 | text = "Just like everything else: by making a pull request :)" 239 | 240 | 241 | -------------------------------------------------------------------------------- /maintainercollector/types.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | // Maintainers defines the struct for a MAINTAINERS file 4 | type Maintainers struct { 5 | Rules map[string]Rule 6 | Roles map[string]Role 7 | Org map[string]*Org 8 | People map[string]Person 9 | } 10 | 11 | // Rule is a project rule 12 | type Rule struct { 13 | Title string `toml:"title,omitempty"` 14 | Text string `toml:"text,omitempty"` 15 | } 16 | 17 | // Role is a project role 18 | type Role struct { 19 | Person string `toml:"person,omitempty"` 20 | Text string `toml:"text,omitempty"` 21 | } 22 | 23 | // Org defines the organization within a project 24 | type Org struct { 25 | People []string 26 | } 27 | 28 | // Person member of the project 29 | type Person struct { 30 | Name string 31 | Email string 32 | GitHub string 33 | } 34 | 35 | // MaintainersDepreciated is an old struct for compatibility 36 | // with the docker/docker maintainers file. 37 | // TODO: delete this once the file in docker/docker repo is updated 38 | type MaintainersDepreciated struct { 39 | Rules map[string]Rule 40 | Organization Organization `toml:"Org"` 41 | People map[string]Person 42 | } 43 | 44 | // Organization defines the project's organization 45 | // TODO: delete this once MaintainersDepreciated is removed 46 | type Organization struct { 47 | BDFL string `toml:"bdfl"` 48 | ChiefArchitect string `toml:"Chief Architect"` 49 | ChiefMaintainer string `toml:"Chief Maintainer"` 50 | CommunityManager string `toml:"Community Manager"` 51 | CoreMaintainers *Org `toml:"Core maintainers"` 52 | Maintainers *Org `toml:"Maintainers"` 53 | DocsMaintainers *Org `toml:"Docs maintainers"` 54 | Curators *Org `toml:"Curators"` 55 | } 56 | -------------------------------------------------------------------------------- /project-template/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Docker open source projects 2 | 3 | Want to hack on this project? Awesome! Here are instructions to get you started. 4 | 5 | This project is a part of the [Docker](https://www.docker.com) project, and follows 6 | the same rules and principles. If you're already familiar with the way 7 | Docker does things, you'll feel right at home. 8 | 9 | Otherwise, go read Docker's 10 | [contributions guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md), 11 | [issue triaging](https://github.com/docker/docker/blob/master/project/ISSUE-TRIAGE.md), 12 | [review process](https://github.com/docker/docker/blob/master/project/REVIEWING.md) and 13 | [branches and tags](https://github.com/docker/docker/blob/master/project/BRANCHES-AND-TAGS.md). 14 | 15 | For an in-depth description of our contribution process, visit the 16 | contributors guide: [Understand how to contribute](https://docs.docker.com/opensource/workflow/make-a-contribution/) 17 | 18 | ### Sign your work 19 | 20 | The sign-off is a simple line at the end of the explanation for the patch. Your 21 | signature certifies that you wrote the patch or otherwise have the right to pass 22 | it on as an open-source patch. The rules are pretty simple: if you can certify 23 | the below (from [developercertificate.org](http://developercertificate.org/)): 24 | 25 | ``` 26 | Developer Certificate of Origin 27 | Version 1.1 28 | 29 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 30 | 1 Letterman Drive 31 | Suite D4700 32 | San Francisco, CA, 94129 33 | 34 | Everyone is permitted to copy and distribute verbatim copies of this 35 | license document, but changing it is not allowed. 36 | 37 | 38 | Developer's Certificate of Origin 1.1 39 | 40 | By making a contribution to this project, I certify that: 41 | 42 | (a) The contribution was created in whole or in part by me and I 43 | have the right to submit it under the open source license 44 | indicated in the file; or 45 | 46 | (b) The contribution is based upon previous work that, to the best 47 | of my knowledge, is covered under an appropriate open source 48 | license and I have the right under that license to submit that 49 | work with modifications, whether created in whole or in part 50 | by me, under the same open source license (unless I am 51 | permitted to submit under a different license), as indicated 52 | in the file; or 53 | 54 | (c) The contribution was provided directly to me by some other 55 | person who certified (a), (b) or (c) and I have not modified 56 | it. 57 | 58 | (d) I understand and agree that this project and the contribution 59 | are public and that a record of the contribution (including all 60 | personal information I submit with it, including my sign-off) is 61 | maintained indefinitely and may be redistributed consistent with 62 | this project or the open source license(s) involved. 63 | ``` 64 | 65 | Then you just add a line to every git commit message: 66 | 67 | Signed-off-by: Joe Smith 68 | 69 | Use your real name (sorry, no pseudonyms or anonymous contributions.) 70 | 71 | If you set your `user.name` and `user.email` git configs, you can sign your 72 | commit automatically with `git commit -s`. 73 | -------------------------------------------------------------------------------- /project-template/INSTRUCTIONS.md: -------------------------------------------------------------------------------- 1 | # Docker open source project template 2 | 3 | This directory contains a template for setting up a new open source 4 | project. 5 | 6 | ## Checklist 7 | 8 | - [ ] Update the "Project name" and description of your project in the README.md. 9 | - [ ] Add details of the project's maintainers to the MAINTAINERS file. 10 | - [ ] Setup DCO checks with "leeroy". Instructions can be found [in the README](https://github.com/docker/leeroy). 11 | - [ ] Request the maintainers to be added to the maintainers mailinglist. 12 | - [ ] Request the maintainers to be "voiced" in the #docker-maintainers IRC channel. 13 | - [ ] Add the standard "labels" for triaging issues, as described in [REVIEWING.md](https://github.com/docker/docker/blob/master/project/REVIEWING.md) 14 | and [ISSUE-TRIAGE.md](https://github.com/docker/docker/blob/master/project/ISSUE-TRIAGE.md) 15 | 16 | 17 | ### After the repository is public 18 | 19 | If you're project is ready to go public: 20 | 21 | - [ ] Create a pull request to have the project added to the central 22 | MAINTAINERS file in the docker/opensource repository. Make sure 23 | to run `make maintainers` to update the MAINTAINERS file with your 24 | changes. An example pull request can be found here; https://github.com/docker/opensource/pull/45 25 | - [ ] Remove this file from the repository :) 26 | - [ ] Spread the word! 27 | 28 | 29 | Congratulations, you're done! 30 | -------------------------------------------------------------------------------- /project-template/LICENSE.code: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | https://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | Copyright 2015 Docker, Inc. 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | https://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. 192 | -------------------------------------------------------------------------------- /project-template/LICENSE.docs: -------------------------------------------------------------------------------- 1 | Attribution-ShareAlike 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution-ShareAlike 4.0 International Public 58 | License 59 | 60 | By exercising the Licensed Rights (defined below), You accept and agree 61 | to be bound by the terms and conditions of this Creative Commons 62 | Attribution-ShareAlike 4.0 International Public License ("Public 63 | License"). To the extent this Public License may be interpreted as a 64 | contract, You are granted the Licensed Rights in consideration of Your 65 | acceptance of these terms and conditions, and the Licensor grants You 66 | such rights in consideration of benefits the Licensor receives from 67 | making the Licensed Material available under these terms and 68 | conditions. 69 | 70 | 71 | Section 1 -- Definitions. 72 | 73 | a. Adapted Material means material subject to Copyright and Similar 74 | Rights that is derived from or based upon the Licensed Material 75 | and in which the Licensed Material is translated, altered, 76 | arranged, transformed, or otherwise modified in a manner requiring 77 | permission under the Copyright and Similar Rights held by the 78 | Licensor. For purposes of this Public License, where the Licensed 79 | Material is a musical work, performance, or sound recording, 80 | Adapted Material is always produced where the Licensed Material is 81 | synched in timed relation with a moving image. 82 | 83 | b. Adapter's License means the license You apply to Your Copyright 84 | and Similar Rights in Your contributions to Adapted Material in 85 | accordance with the terms and conditions of this Public License. 86 | 87 | c. BY-SA Compatible License means a license listed at 88 | creativecommons.org/compatiblelicenses, approved by Creative 89 | Commons as essentially the equivalent of this Public License. 90 | 91 | d. Copyright and Similar Rights means copyright and/or similar rights 92 | closely related to copyright including, without limitation, 93 | performance, broadcast, sound recording, and Sui Generis Database 94 | Rights, without regard to how the rights are labeled or 95 | categorized. For purposes of this Public License, the rights 96 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 97 | Rights. 98 | 99 | e. Effective Technological Measures means those measures that, in the 100 | absence of proper authority, may not be circumvented under laws 101 | fulfilling obligations under Article 11 of the WIPO Copyright 102 | Treaty adopted on December 20, 1996, and/or similar international 103 | agreements. 104 | 105 | f. Exceptions and Limitations means fair use, fair dealing, and/or 106 | any other exception or limitation to Copyright and Similar Rights 107 | that applies to Your use of the Licensed Material. 108 | 109 | g. License Elements means the license attributes listed in the name 110 | of a Creative Commons Public License. The License Elements of this 111 | Public License are Attribution and ShareAlike. 112 | 113 | h. Licensed Material means the artistic or literary work, database, 114 | or other material to which the Licensor applied this Public 115 | License. 116 | 117 | i. Licensed Rights means the rights granted to You subject to the 118 | terms and conditions of this Public License, which are limited to 119 | all Copyright and Similar Rights that apply to Your use of the 120 | Licensed Material and that the Licensor has authority to license. 121 | 122 | j. Licensor means the individual(s) or entity(ies) granting rights 123 | under this Public License. 124 | 125 | k. Share means to provide material to the public by any means or 126 | process that requires permission under the Licensed Rights, such 127 | as reproduction, public display, public performance, distribution, 128 | dissemination, communication, or importation, and to make material 129 | available to the public including in ways that members of the 130 | public may access the material from a place and at a time 131 | individually chosen by them. 132 | 133 | l. Sui Generis Database Rights means rights other than copyright 134 | resulting from Directive 96/9/EC of the European Parliament and of 135 | the Council of 11 March 1996 on the legal protection of databases, 136 | as amended and/or succeeded, as well as other essentially 137 | equivalent rights anywhere in the world. 138 | 139 | m. You means the individual or entity exercising the Licensed Rights 140 | under this Public License. Your has a corresponding meaning. 141 | 142 | 143 | Section 2 -- Scope. 144 | 145 | a. License grant. 146 | 147 | 1. Subject to the terms and conditions of this Public License, 148 | the Licensor hereby grants You a worldwide, royalty-free, 149 | non-sublicensable, non-exclusive, irrevocable license to 150 | exercise the Licensed Rights in the Licensed Material to: 151 | 152 | a. reproduce and Share the Licensed Material, in whole or 153 | in part; and 154 | 155 | b. produce, reproduce, and Share Adapted Material. 156 | 157 | 2. Exceptions and Limitations. For the avoidance of doubt, where 158 | Exceptions and Limitations apply to Your use, this Public 159 | License does not apply, and You do not need to comply with 160 | its terms and conditions. 161 | 162 | 3. Term. The term of this Public License is specified in Section 163 | 6(a). 164 | 165 | 4. Media and formats; technical modifications allowed. The 166 | Licensor authorizes You to exercise the Licensed Rights in 167 | all media and formats whether now known or hereafter created, 168 | and to make technical modifications necessary to do so. The 169 | Licensor waives and/or agrees not to assert any right or 170 | authority to forbid You from making technical modifications 171 | necessary to exercise the Licensed Rights, including 172 | technical modifications necessary to circumvent Effective 173 | Technological Measures. For purposes of this Public License, 174 | simply making modifications authorized by this Section 2(a) 175 | (4) never produces Adapted Material. 176 | 177 | 5. Downstream recipients. 178 | 179 | a. Offer from the Licensor -- Licensed Material. Every 180 | recipient of the Licensed Material automatically 181 | receives an offer from the Licensor to exercise the 182 | Licensed Rights under the terms and conditions of this 183 | Public License. 184 | 185 | b. Additional offer from the Licensor -- Adapted Material. 186 | Every recipient of Adapted Material from You 187 | automatically receives an offer from the Licensor to 188 | exercise the Licensed Rights in the Adapted Material 189 | under the conditions of the Adapter's License You apply. 190 | 191 | c. No downstream restrictions. You may not offer or impose 192 | any additional or different terms or conditions on, or 193 | apply any Effective Technological Measures to, the 194 | Licensed Material if doing so restricts exercise of the 195 | Licensed Rights by any recipient of the Licensed 196 | Material. 197 | 198 | 6. No endorsement. Nothing in this Public License constitutes or 199 | may be construed as permission to assert or imply that You 200 | are, or that Your use of the Licensed Material is, connected 201 | with, or sponsored, endorsed, or granted official status by, 202 | the Licensor or others designated to receive attribution as 203 | provided in Section 3(a)(1)(A)(i). 204 | 205 | b. Other rights. 206 | 207 | 1. Moral rights, such as the right of integrity, are not 208 | licensed under this Public License, nor are publicity, 209 | privacy, and/or other similar personality rights; however, to 210 | the extent possible, the Licensor waives and/or agrees not to 211 | assert any such rights held by the Licensor to the limited 212 | extent necessary to allow You to exercise the Licensed 213 | Rights, but not otherwise. 214 | 215 | 2. Patent and trademark rights are not licensed under this 216 | Public License. 217 | 218 | 3. To the extent possible, the Licensor waives any right to 219 | collect royalties from You for the exercise of the Licensed 220 | Rights, whether directly or through a collecting society 221 | under any voluntary or waivable statutory or compulsory 222 | licensing scheme. In all other cases the Licensor expressly 223 | reserves any right to collect such royalties. 224 | 225 | 226 | Section 3 -- License Conditions. 227 | 228 | Your exercise of the Licensed Rights is expressly made subject to the 229 | following conditions. 230 | 231 | a. Attribution. 232 | 233 | 1. If You Share the Licensed Material (including in modified 234 | form), You must: 235 | 236 | a. retain the following if it is supplied by the Licensor 237 | with the Licensed Material: 238 | 239 | i. identification of the creator(s) of the Licensed 240 | Material and any others designated to receive 241 | attribution, in any reasonable manner requested by 242 | the Licensor (including by pseudonym if 243 | designated); 244 | 245 | ii. a copyright notice; 246 | 247 | iii. a notice that refers to this Public License; 248 | 249 | iv. a notice that refers to the disclaimer of 250 | warranties; 251 | 252 | v. a URI or hyperlink to the Licensed Material to the 253 | extent reasonably practicable; 254 | 255 | b. indicate if You modified the Licensed Material and 256 | retain an indication of any previous modifications; and 257 | 258 | c. indicate the Licensed Material is licensed under this 259 | Public License, and include the text of, or the URI or 260 | hyperlink to, this Public License. 261 | 262 | 2. You may satisfy the conditions in Section 3(a)(1) in any 263 | reasonable manner based on the medium, means, and context in 264 | which You Share the Licensed Material. For example, it may be 265 | reasonable to satisfy the conditions by providing a URI or 266 | hyperlink to a resource that includes the required 267 | information. 268 | 269 | 3. If requested by the Licensor, You must remove any of the 270 | information required by Section 3(a)(1)(A) to the extent 271 | reasonably practicable. 272 | 273 | b. ShareAlike. 274 | 275 | In addition to the conditions in Section 3(a), if You Share 276 | Adapted Material You produce, the following conditions also apply. 277 | 278 | 1. The Adapter's License You apply must be a Creative Commons 279 | license with the same License Elements, this version or 280 | later, or a BY-SA Compatible License. 281 | 282 | 2. You must include the text of, or the URI or hyperlink to, the 283 | Adapter's License You apply. You may satisfy this condition 284 | in any reasonable manner based on the medium, means, and 285 | context in which You Share Adapted Material. 286 | 287 | 3. You may not offer or impose any additional or different terms 288 | or conditions on, or apply any Effective Technological 289 | Measures to, Adapted Material that restrict exercise of the 290 | rights granted under the Adapter's License You apply. 291 | 292 | 293 | Section 4 -- Sui Generis Database Rights. 294 | 295 | Where the Licensed Rights include Sui Generis Database Rights that 296 | apply to Your use of the Licensed Material: 297 | 298 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 299 | to extract, reuse, reproduce, and Share all or a substantial 300 | portion of the contents of the database; 301 | 302 | b. if You include all or a substantial portion of the database 303 | contents in a database in which You have Sui Generis Database 304 | Rights, then the database in which You have Sui Generis Database 305 | Rights (but not its individual contents) is Adapted Material, 306 | 307 | including for purposes of Section 3(b); and 308 | c. You must comply with the conditions in Section 3(a) if You Share 309 | all or a substantial portion of the contents of the database. 310 | 311 | For the avoidance of doubt, this Section 4 supplements and does not 312 | replace Your obligations under this Public License where the Licensed 313 | Rights include other Copyright and Similar Rights. 314 | 315 | 316 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 317 | 318 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 319 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 320 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 321 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 322 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 323 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 324 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 325 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 326 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 327 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 328 | 329 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 330 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 331 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 332 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 333 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 334 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 335 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 336 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 337 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 338 | 339 | c. The disclaimer of warranties and limitation of liability provided 340 | above shall be interpreted in a manner that, to the extent 341 | possible, most closely approximates an absolute disclaimer and 342 | waiver of all liability. 343 | 344 | 345 | Section 6 -- Term and Termination. 346 | 347 | a. This Public License applies for the term of the Copyright and 348 | Similar Rights licensed here. However, if You fail to comply with 349 | this Public License, then Your rights under this Public License 350 | terminate automatically. 351 | 352 | b. Where Your right to use the Licensed Material has terminated under 353 | Section 6(a), it reinstates: 354 | 355 | 1. automatically as of the date the violation is cured, provided 356 | it is cured within 30 days of Your discovery of the 357 | violation; or 358 | 359 | 2. upon express reinstatement by the Licensor. 360 | 361 | For the avoidance of doubt, this Section 6(b) does not affect any 362 | right the Licensor may have to seek remedies for Your violations 363 | of this Public License. 364 | 365 | c. For the avoidance of doubt, the Licensor may also offer the 366 | Licensed Material under separate terms or conditions or stop 367 | distributing the Licensed Material at any time; however, doing so 368 | will not terminate this Public License. 369 | 370 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 371 | License. 372 | 373 | 374 | Section 7 -- Other Terms and Conditions. 375 | 376 | a. The Licensor shall not be bound by any additional or different 377 | terms or conditions communicated by You unless expressly agreed. 378 | 379 | b. Any arrangements, understandings, or agreements regarding the 380 | Licensed Material not stated herein are separate from and 381 | independent of the terms and conditions of this Public License. 382 | 383 | 384 | Section 8 -- Interpretation. 385 | 386 | a. For the avoidance of doubt, this Public License does not, and 387 | shall not be interpreted to, reduce, limit, restrict, or impose 388 | conditions on any use of the Licensed Material that could lawfully 389 | be made without permission under this Public License. 390 | 391 | b. To the extent possible, if any provision of this Public License is 392 | deemed unenforceable, it shall be automatically reformed to the 393 | minimum extent necessary to make it enforceable. If the provision 394 | cannot be reformed, it shall be severed from this Public License 395 | without affecting the enforceability of the remaining terms and 396 | conditions. 397 | 398 | c. No term or condition of this Public License will be waived and no 399 | failure to comply consented to unless expressly agreed to by the 400 | Licensor. 401 | 402 | d. Nothing in this Public License constitutes or may be interpreted 403 | as a limitation upon, or waiver of, any privileges and immunities 404 | that apply to the Licensor or You, including from the legal 405 | processes of any jurisdiction or authority. 406 | 407 | 408 | ======================================================================= 409 | 410 | Creative Commons is not a party to its public licenses. 411 | Notwithstanding, Creative Commons may elect to apply one of its public 412 | licenses to material it publishes and in those instances will be 413 | considered the "Licensor." Except for the limited purpose of indicating 414 | that material is shared under a Creative Commons public license or as 415 | otherwise permitted by the Creative Commons policies published at 416 | creativecommons.org/policies, Creative Commons does not authorize the 417 | use of the trademark "Creative Commons" or any other trademark or logo 418 | of Creative Commons without its prior written consent including, 419 | without limitation, in connection with any unauthorized modifications 420 | to any of its public licenses or any other arrangements, 421 | understandings, or agreements concerning use of licensed material. For 422 | the avoidance of doubt, this paragraph does not form part of the public 423 | licenses. 424 | 425 | Creative Commons may be contacted at creativecommons.org. 426 | -------------------------------------------------------------------------------- /project-template/MAINTAINERS: -------------------------------------------------------------------------------- 1 | # Project maintainers file 2 | # 3 | # This file describes who runs the docker/PROJECT project and how. 4 | # This is a living document - if you see something out of date or missing, speak up! 5 | # 6 | # It is structured to be consumable by both humans and programs. 7 | # To extract its contents programmatically, use any TOML-compliant parser. 8 | # 9 | # This file is compiled into the MAINTAINERS file in docker/opensource. 10 | # 11 | [Org] 12 | [Org."Core maintainers"] 13 | people = [ 14 | "MAINTAINER", 15 | ] 16 | 17 | [people] 18 | 19 | # A reference list of all people associated with the project. 20 | # All other sections should refer to people by their canonical key 21 | # in the people section. 22 | 23 | # ADD YOURSELF HERE IN ALPHABETICAL ORDER 24 | 25 | [people.MAINTAINER] 26 | Name = "NAME" 27 | Email = "EMAIL" 28 | GitHub = "MAINTAINER" 29 | -------------------------------------------------------------------------------- /project-template/README.md: -------------------------------------------------------------------------------- 1 | # Add your project name here 2 | 3 | Add a description here 4 | 5 | ## Reporting security issues 6 | 7 | The maintainers take security seriously. If you discover a security issue, 8 | please bring it to their attention right away! 9 | 10 | Please **DO NOT** file a public issue, instead send your report privately to 11 | [security@docker.com](mailto:security@docker.com). 12 | 13 | Security reports are greatly appreciated and we will publicly thank you for it. 14 | We also like to send gifts—if you're into Docker schwag, make sure to let 15 | us know. We currently do not offer a paid security bounty program, but are not 16 | ruling it out in the future. 17 | 18 | 19 | ## Copyright and license 20 | 21 | Copyright © 2015 Docker, Inc. All rights reserved, except as follows. Code 22 | is released under the [Apache 2.0 license](LICENSE.code). This `README.md` 23 | file, the [`CONTRIBUTING.md`](CONTRIBUTING.md) file, and files in the 24 | `docs` folder are licensed under the Creative Commons Attribution 4.0 25 | International License under the terms and conditions set forth in the file 26 | [`LICENSE.docs`](LICENSE.docs). You may obtain a duplicate copy of the 27 | same license, titled CC BY-SA 4.0, at 28 | http://creativecommons.org/licenses/by-sa/4.0/. 29 | --------------------------------------------------------------------------------