Daylight: the intial release. We encourage you to contribute, explore our new framework, to seek out strange new bugs and build new possiblities, to boldly go where we have not gone before.
Daylight was built as an API for a web application on the AT&T Cloud team
using the domain model needed for several tasks in the organization. We
wanted to be able to lift sections of our codebase out of the monolithic
codebase with little-to-no code changes between ActiveRecord and
ActiveResource.
The functionality was built for the organization's usecases and while documenting, we've noticed "holes" or possiblities within the codebase.
Daylight is the extracted files that sat between our API models and the Rails components. We've also extracted some of our tools such as the mocking framework we built and Documentation Rails engine with hopes that they might serve useful to API developers.
Daylight is named as such for our intent the framework would be able to "see the light of day".
We are using Github's Issues to track all future work and bugs. Please investigate if there is a bug already submitted for your the issue you've found and if not, submit a new issue.
Include a title and a clear statement of a problem. If you can, add the steps to reproduce, a backtrace, the Daylight gem version as well as the Rails & ActiveModelSerializer version numbers. Please include example code when possible.
Daylight is a self-contained, running rspec tests against a dummy Rails application backed by a sqlite database. Once you have your build Environment up and running, you will be able to run the tests.
Clone (or fork) the Daylight repository:
$ git clone git://github.com/att-cloud/daylight.git
Switch to your own branch:
$ cd daylight
$ git checkout -b my_branch
Build your code and tests. Ensure they all run, see if you a missing any tests:
$ cd daylight
$ rake spec
$ rake rcov
Commit your changes:
$ git commit -a
Issue a pull request using your branch with your code changes.
To better understand how a framework extends or alters the underlying Rails technology and help navigate the code for contributing, here are details and guidelines on how Daylight was built.
Please rely on the following for reference or feel free to ask or suggest improvements: