README.markdown

   1 Welcome to Basic Web Portal
   2 ===========================
   3
   4 This is a base Application for a Portal Type System
   5
   6 Gems Used
   7 =========
   8
   9 * Devise (1.1.2) for Authentication
  10 * Declarative_Authorization for Authorization
  11
  12
  13 CSS Frameworks
  14 ==============
  15
  16 We use the [BluePrint Framework](http://blueprintcss.org) to give a nice layout, but feel free to use your own
  17
  18
  19 Wiki
  20 ====
  21
  22 Please feel free to use the [WIKI](http://wiki.github.com/msimkins/Basic_Web_Portal/) for documenting this
  23
  24 Support Issues
  25 ==============
  26
  27 Please create a [Support Issue](http://github.com/msimkins/Basic_Web_Portal/issues) if you believe I have made a major error in the code, or would like a feature added
  28
  29 How to contribute
  30 =================
  31
  32 Please ensure that you provide appropriate spec/test coverage and ensure the documentation is up-to-date.
  33
  34 Bonus points if you perform your changes in a clean topic branch rather than master, and if you create an
  35 issue on GH to discuss your changes. __Pull requests tend to get lost.__
  36
  37 Please also keep your commits __atomic__ so that they are more likely to apply cleanly.
  38
  39 That means that each commit should contain the smallest possible logical change.
  40
  41 Don’t commit two features at once, don’t update the gemspec at the same time you add a feature,
  42 don’t fix a whole bunch of whitespace in a file at the same time you change a few lines, etc, etc.
  43
  44 Maintainers & Contributors
  45 ==========================
  46
  47 This project is maintained by Mike Simkins, Contributions are welcome, and you will be mentioned here