Skip to content

Instantly share code, notes, and snippets.

@jbuck
Created January 21, 2013 22:37
Show Gist options
  • Save jbuck/4590186 to your computer and use it in GitHub Desktop.
Save jbuck/4590186 to your computer and use it in GitHub Desktop.
The Mo-Factor App
=================
In the spirit of [Twelve-Factor Apps](http://www.12factor.net/), this is a list of concrete things that you can do to make your software better. Some of it overlaps with Twelve-Factor Apps, but it's all good.
Uses git/Github
---------------
Has a README.md file
--------------------
The README.md should answer common questions like:
* What does your software do? Is it an application? A library?
* How do I install and run your software? What are the prerequisites? What operating systems does it run on?
* How do I change the configuration of your software? What is the API for your software? Provide examples, as well as a reference. For larger software packages, you may need to move this documentation somewhere else. If do you, then link to it from here.
* Where is the community around this software? List IRC channels, mailing lists, issue trackers, code repositories, etc.
* How do I contribute code? You should just link to your CONTRIBUTING.md file.
Has a CONTRIBUTING.md file
--------------------------
Has a LICENSE.txt file
----------------------
Has a CONTRIBUTORS.txt file
---------------------------
Has an IRC commit notification bot
----------------------------------
Has continuous integration
--------------------------
Has a Procfile
--------------
A [Procfile](https://devcenter.heroku.com/articles/procfile) in the root of the repository allows for easy deployment of your software on Heroku. We can use Heroku for development since it's free for one web process,
Has a git mirror
----------------
In the event that Github goes down, it's always nice to have a backup so you can keep working. Fortunately, Mozilla already provides one for us: [http://gitmirror.mozilla.org/](http://gitmirror.mozilla.org/). Mirror setup instructions are located at [https://intranet.mozilla.org/Git](https://intranet.mozilla.org/Git).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment