From d84ccbc52a5555c64fa8dbf01b7e0089f516fb5a Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Sat, 12 Aug 2017 15:40:07 +0200 Subject: [PATCH] doc: add bots documentation. - move contributing guide - move maintainer guide --- .github/CONTRIBUTING.md => CONTRIBUTING.md | 6 +- .github/MAINTAINER.md => MAINTAINER.md | 70 +++++++++++++++++----- README.md | 4 +- 3 files changed, 60 insertions(+), 20 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (95%) rename .github/MAINTAINER.md => MAINTAINER.md (66%) diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 95% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md index f2d4ad105..415206ec1 100644 --- a/.github/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -189,7 +189,7 @@ The title must be short and descriptive. (~60 characters) ### Description -- Respect the issue template as more as possible. [template](ISSUE_TEMPLATE.md) +- Respect the issue template as much as possible. [template](.github/ISSUE_TEMPLATE.md) - If it's possible use the command `traefik bug`. See https://www.youtube.com/watch?v=Lyz62L8m93I. - Explain the conditions which led you to write this issue: the context. - The context should lead to something, an idea or a problem that you’re facing. @@ -205,7 +205,7 @@ The title must be short and descriptive. (~60 characters) ### Description -- Respect the pull request template as more as possible. [template](PULL_REQUEST_TEMPLATE.md) +- Respect the pull request template as much as possible. [template](.github/PULL_REQUEST_TEMPLATE.md) - Explain the conditions which led you to write this PR: the context. - The context should lead to something, an idea or a problem that you’re facing. - Remain clear and concise. @@ -222,5 +222,7 @@ The title must be short and descriptive. (~60 characters) - Add tests. - Address review comments in terms of additional commits. - Do not amend/squash existing ones unless the PR is trivial. +- If a PR involves changes to third-party dependencies, the commits pertaining to the vendor folder and the manifest/lock file(s) should be committed separated. + Read [10 tips for better pull requests](http://blog.ploeh.dk/2015/01/15/10-tips-for-better-pull-requests/). diff --git a/.github/MAINTAINER.md b/MAINTAINER.md similarity index 66% rename from .github/MAINTAINER.md rename to MAINTAINER.md index 49b3fa040..d6302c507 100644 --- a/.github/MAINTAINER.md +++ b/MAINTAINER.md @@ -2,15 +2,58 @@ ## The team -- Emile Vauge [@emilevauge](https://github.com/emilevauge) -- Vincent Demeester [@vdemeester](https://github.com/vdemeester) -- Ed Robinson [@errm](https://github.com/errm) -- Daniel Tomcej [@dtomcej](https://github.com/dtomcej) -- Manuel Zapf [@SantoDE](https://github.com/SantoDE) -- Timo Reimann [@timoreimann](https://github.com/timoreimann) -- Ludovic Fernandez [@ldez](https://github.com/ldez) -- Julien Salleyron [@juliens](https://github.com/juliens) -- Nicolas Mengin [@nmengin](https://github.com/nmengin) +* Emile Vauge [@emilevauge](https://github.com/emilevauge) +* Vincent Demeester [@vdemeester](https://github.com/vdemeester) +* Ed Robinson [@errm](https://github.com/errm) +* Daniel Tomcej [@dtomcej](https://github.com/dtomcej) +* Manuel Zapf [@SantoDE](https://github.com/SantoDE) +* Timo Reimann [@timoreimann](https://github.com/timoreimann) +* Ludovic Fernandez [@ldez](https://github.com/ldez) +* Julien Salleyron [@juliens](https://github.com/juliens) +* Nicolas Mengin [@nmengin](https://github.com/nmengin) + + +## PR review process: + +* The status `needs-design-review` is only used in complex/heavy/tricky PRs. +* From `1` to `2`: 1 design LGTM in comment, by a senior maintainer, if needed. +* From `2` to `3`: 3 LGTM by any maintainer. +* If needed, a specific maintainer familiar with a particular domain can be requested for the review. + +We use [PRM](https://github.com/ldez/prm) to manage locally pull requests. + + +## Bots + +### [Myrmica Lobicornis](https://github.com/containous/lobicornis/) + +**Update and Merge Pull Request** + +The maintainer giving the final LGTM must add the `status/3-needs-merge` label to trigger the merge bot. + +By default, a squash-rebase merge will be carried out. +If you want to preserve commits you must add `bot/merge-method-rebase` before `status/3-needs-merge`. + +The status `status/4-merge-in-progress` is only for the bot. + +If the bot is not able to perform the merge, the label `bot/need-human-merge` is added. +In this case you must solve conflicts/CI/... and after you only need to remove `bot/need-human-merge`. + + +### [Myrmica Bibikoffi](https://github.com/containous/bibikoffi/) + +* closes stale issues [cron] + * use some criterion as number of days between creation, last update, labels, ... + + +### [Myrmica Aloba](https://github.com/containous/aloba) + +**Manage GitHub labels** + +* Add labels on new PR [GitHub WebHook] +* Add and remove `contributor/waiting-for-corrections` label when a review request changes [GitHub WebHook] +* Weekly report of PR status on Slack (CaptainPR) [cron] + ## Labels @@ -65,6 +108,7 @@ If we open/look an issue/PR, we must add a `kind/*` and an `area/*`. * `area/provider/ecs`: ECS related. * `area/provider/etcd`: Etcd related. * `area/provider/eureka`: Eureka related. +* `area/provider/file`: file provider related. * `area/provider/k8s`: Kubernetes related. * `area/provider/marathon`: Marathon related. * `area/provider/mesos`: Mesos related. @@ -96,10 +140,4 @@ The `status/*` labels represent the desired state in the workflow. * `status/1-needs-design-review`: need a design review. **(only for PR)** * `status/2-needs-review`: need a code/documentation review. **(only for PR)** * `status/3-needs-merge`: ready to merge. **(only for PR)** - -## PR review process: - -* If needed, a specific maintainer can be required to make a review (according to its knowledge areas) -* The status `needs-design-review` is only used in complex/heavy/tricky PRs. -* From `1` to `2`: 1 design LGTM in comment, by a senior maintainer, if needed. -* From `2` to `3`: 3 LGTM by any maintainer. +* `status/4-merge-in-progress`: merge in progress. _[bot only]_ diff --git a/README.md b/README.md index d5e2a9424..133d4b53c 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,7 @@ If you prefer commercial support, please contact [containo.us](https://containo. ## Contributing -Please refer to [contributing documentation](.github/CONTRIBUTING.md). +Please refer to [contributing documentation](CONTRIBUTING.md). ### Code of Conduct @@ -165,7 +165,7 @@ By participating in this project you agree to abide by its terms. ## Maintainers -[Information about process and maintainers](.github/MAINTAINER.md) +[Information about process and maintainers](MAINTAINER.md) ## Plumbing