Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cfpb/email-templates

Design, research, and front-end implementation of responsive email templates for the CFPB.
https://github.com/cfpb/email-templates

Last synced: 17 days ago
JSON representation

Design, research, and front-end implementation of responsive email templates for the CFPB.

Awesome Lists containing this project

README

        

# CFPB Email Templates

All our interactions with the public (anyone outside the bureau,
including other federal or state agencies, institutions, and consummers)
should be easy to understand and use regardless of the communication channel
(website, printed pamphlets, reports, our consumer response hotline, and email).
Currently our email communications have not been given the same consideration
as some of our other channels of communication.

This project aims to provide a technical framework, templates,
and a content strategy for external communication via email.

Content guidelines will be hosted in the
[Design Manual](https://cfpb.github.io/design-manual/).

## Dependencies

Describe any dependencies that must be installed for this software to work.
This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth.
If specific versions of other software are required, or or known not to work, call that out.

## Installation

Detailed instructions on how to install, configure, and get the project running.
This should be frequently tested to ensure reliability. Alternatively, a link to
another page is fine, but it's important that this works.

## Configuration

If the software is configurable, describe it in detail, either here or in other documentation to which you link.

## Usage

Show users how to use the software.
Be specific.
Use appropriate formatting when showing code snippets.

## How to test the software

If the software includes automated tests, detail how to run those tests.

## Known issues

Document any known significant shortcomings with the software.

## Getting help

Instruct users how to get help with this software; this might include links to an issue tracker, wiki, mailing list, etc.

**Example**

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

## Getting involved

This section should detail why people should get involved and describe key areas you are
currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building
important pieces, etc.

General instructions on _how_ to contribute should be stated with a link to [CONTRIBUTING](CONTRIBUTING.md).

----

## Open source licensing info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)

----

## Credits and references

1. Projects that inspired you
2. Related projects
3. Books, papers, talks, or other sources that have meaniginful impact or influence on this project