From aa4496688f479af397345c66a555a6bbcc92d947 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 29 Sep 2024 00:38:39 -0700 Subject: [PATCH] Document how to resolve issues with `mr-roboto` --- docs/contributing/core/continuous-integration.md | 8 ++++++++ docs/contributing/index.md | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/contributing/core/continuous-integration.md b/docs/contributing/core/continuous-integration.md index 5f1d51c48..43723d199 100644 --- a/docs/contributing/core/continuous-integration.md +++ b/docs/contributing/core/continuous-integration.md @@ -32,6 +32,14 @@ GitHub workflows should pass before running Jenkins checks and before merging an [`mr-roboto`](https://github.com/plone/mr.roboto) enforces the requirement of a signed Plone Contributor Agreement from a new contributor, and being assigned to a Plone team on GitHub. It also suggests to run Jenkins for many Plone packages. +When you push a commit to a Plone repository on GitHub, the email address in your commit must match an email address in your GitHub account. +If it does not match, then `mr.roboto` will notify you that there is a problem that prevents your pull request from being merged. +You must resolve the issue. + +To change the email address in your commits, see [Setting your commit email address](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address]. + +To add an email address to your GitHub account, see [Adding an email address to your GitHub account](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). + ## Jenkins diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 0b2bb8d50..a84af9a7c 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -31,7 +31,7 @@ You grant permission by signing and returning the Plone Contributor Agreement. A volunteer member of the Plone Foundation will review your signed agreement. -If accepted, your GitHub account will be added to a team in the Plone GitHub organization with appropriate access, and you will simultaneously receive an email notification from GitHub. +If accepted, your GitHub account will be added to a team in the Plone GitHub organization with appropriate access, and you will simultaneously receive an email from GitHub for you to accept the invitation to join the team. Allow up to one week for processing. Contact the Plone Foundation by its email address for further information, including the status of your request.