synapse icon indicating copy to clipboard operation
synapse copied to clipboard

Document Google OpenID Connect email attribute

Open ptman opened this issue 3 years ago • 1 comments

In the example config

Pull Request Checklist

  • [x] Pull request is based on the develop branch
  • [ ] Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • [ ] Pull request includes a sign off
  • [ ] Code style is correct (run the linters)

ptman avatar Oct 06 '22 13:10 ptman

This is a very short documentation change that I made using the GitHub web editor. Please let me know if all the boxes still need to be ticked

ptman avatar Oct 06 '22 13:10 ptman

* add a changelog entry
* a comment with your sign-off

How do you perform these steps using the GitHub web interface?

There's no need to run the linters for a documentation-only change like this.

Thanks, that's what I thought.

ptman avatar Oct 07 '22 13:10 ptman

How do you perform these steps using the GitHub web interface?

For adding a changelog entry, I think you want to go to the fork and branch that github has created for you and follow the instructions here.

For adding a sign-off, writing a comment on this PR with Signed-off-by: as per the notes here is all that's needed.

DMRobertson avatar Oct 07 '22 13:10 DMRobertson

* add a changelog entry
* a comment with your sign-off

How do you perform these steps using the GitHub web interface?

You can go to https://github.com/ptman/synapse/tree/patch-1/changelog.d and click the + in the top right and choose "Create new file".

For sign-off you can just add it manually via a comment on the PR.

clokep avatar Oct 07 '22 13:10 clokep

Signed-off-by: Paul Tötterman [email protected]

ptman avatar Oct 07 '22 13:10 ptman