From 0a0325e40c00efa56b98bf2d92cf40821d75eaf2 Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Thu, 1 Nov 2018 20:33:25 -0700 Subject: Flesh out a README --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c272454..e759810 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Mailgun Mailmap -A work in progress... +Mail configuration for rust-lang domains. + +> **Note**: This repository is still being tested. The words below describe in +> theory what happens if all testing goes well. + +This repository contains mail configuration for all rust-lang domains. All our +mail is handled by [Mailgun](https://www.mailgun.com/). On Mailgun all our mail +goes through mailing lists. This means that any email send to an email address +for rust-lang is then broadcast to a list of members. + +Configuration of mailing lists is done via this git repository. The +[`mailmap.toml`](https://github.com/rust-lang/mailgun-mailmap/blob/master/mailmap.toml) +file contains a description of all mailing lists for the rust-lang domains. Each +mailing list has a list of members as well. + +Updates to this repository should be done through pull requests. Anyone can send +a pull request! + +When a pull requests is merged Travis will run and will sync the state of +`mailmap.toml` to Mailgun itself. -- cgit v1.2.3