1
0
mirror of https://github.com/jhillyerd/inbucket.git synced 2026-01-08 20:21:55 +00:00

Add contributing guide

This commit is contained in:
James Hillyerd
2016-12-31 00:35:59 +00:00
parent 2f5d80a521
commit ff481c56c6
2 changed files with 56 additions and 11 deletions

View File

@@ -1,5 +1,6 @@
Inbucket [![Build Status](https://travis-ci.org/jhillyerd/inbucket.png?branch=master)][Build Status]
========
Inbucket
=============================================================================
[![Build Status](https://travis-ci.org/jhillyerd/inbucket.png?branch=master)][Build Status]
Inbucket is an email testing service; it will accept messages for any email
address and make them available via web, REST and POP3. Once compiled,
@@ -8,21 +9,22 @@ are all built in).
Read more at the [Inbucket Website]
Development Status
------------------
## Development Status
Inbucket is currently production quality: it is being used for real work.
Please see the [Change Log] and [Issues List] for more details.
Please see the [Change Log] and [Issues List] for more details. If you'd like
to contribute code to the project check out [CONTRIBUTING.md].
Homebrew Tap
------------
## Homebrew Tap
Inbucket has an OS X [Homebrew] tap available as [jhillyerd/inbucket][Homebrew Tap],
see the `README.md` there for installation instructions.
Building from Source
--------------------
## Building from Source
You will need a functioning [Go installation][Google Go] for this to work.
@@ -41,8 +43,8 @@ the web interface will be available at [localhost:9000](http://localhost:9000/).
The Inbucket website has a more complete guide to
[installing from source][From Source]
About
-----
## About
Inbucket is written in [Google Go]
@@ -51,6 +53,7 @@ version can be found at https://github.com/jhillyerd/inbucket
[Build Status]: https://travis-ci.org/jhillyerd/inbucket
[Change Log]: https://github.com/jhillyerd/inbucket/blob/master/CHANGELOG.md
[CONTRIBUTING.md]: https://github.com/jhillyerd/inbucket/blob/develop/CONTRIBUTING.md
[From Source]: http://www.inbucket.org/installation/from-source.html
[Google Go]: http://golang.org/
[Homebrew]: http://brew.sh/